README.md

YunoHost apps directory

    

Here you will find the repositories and versions of every apps integrated in YunoHost.

https://yunohost.org/apps

Lists

• official.json contains the repository information of validated apps.
• community.json contains all references to known YunoHost packages. If you want to add your app to the list, please send a Pull Request

Usage

The official package list is automatically fetched. If you want to enable the community package list on your YunoHost instance:

sudo yunohost app fetchlist -n community -u https://yunohost.org/community.json

Contributing

How to add your app to the community list

• Fork and edit the community list
• Add your app's ID and git information at the right alphabetical place
• Indicate the app's functioning state: notworking, inprogress, or ready
• Send a Pull Request

An example app addition:

    "wallabag": {
        "branch": "master",
        "revision": "c2fc62438ac5c9503e3f4ebfdc425ec03a0ec0c0",
        "url": "https://github.com/abeudin/wallabag_ynh.git",
        "state": "ready"
    }

How to add an app to the official list

Same steps than above, but on the official.json list with the status validated. The integration will be discussed on the Pull Request.

Important: You will have to find a maintainer willing to take care of the package while published if you want your app to be validated.

Helper script

You can use the add_or_update.py python script to add or update your app from one of the 2 json files.

Usage:

python ./add_or_update.py [community.json OR official.json] [github url [github url [github url ...]]]

More information on yunohost.org/packaging_apps