YunoHost apps catalog
This repository contains the default YunoHost app catalog, as well as related tools that can be run manually or automatically.
The catalog is stored in apps.toml
and is browsable here:
https://apps.yunohost.org
It contains references to the apps' repositories, along with a few metadata about
them such as their category or maintenance state. This file is regularly read by
tools/list_builder.py
which publish the results on https://app.yunohost.org/default.
Note The YunoHost project will NOT integrate in its catalog applications that are not based on free-software upstreams.
Note We strongly encourage you to transfer the ownership of your repository to the YunoHost-Apps organization on GitHub, such that the community will help you with keeping your app working and up to date with packaging evolutions on the long run.
To add your application to the catalog:
apps.toml
file
notworking
, inprogress
, or working
categories.toml
antifeatures.toml
(or remove the antifeatures
key if there's none)potential_alternative_to
key if there's none)level
entry by yourself. Our automatic test suite ("the CI") will handle it.logos
folder. Please keep this logo as small as possible. It also must be square (or almost square). The filename must be the name of the app in lower case.App example addition:
[your_app]
antifeatures = [ "deprecated-software" ] # Replace with the appropriate category id found in antifeatures.toml, remove if no relevant antifeature applies
potential_alternative_to = [ "YouTube" ] # Indicate if your app can be thought of as an alternative to popular proprietary services (or remove if none applies)
category = "foobar" # Replace with the appropriate category id found in categories.toml, don't invent a category
state = "working"
url = "https://github.com/YunoHost-Apps/your_app_ynh"
Warning Implicitly, the catalog publishes the
HEAD
of branchmaster
(this can be overwritten by adding keysbranch
andrevision
). Therefore, be careful that any commit on themaster
branch will automatically be published. We strongly encourage you to develop in separate branches, and only merge changes that were carefully tested. Get in touch with the Apps group to obtain an access to the developer CI where you'll be able to test your app easily.
App packagers should not manually set their apps' level. The levels of all the apps are automatically updated once a week on Friday, according to the results from the official app CI.
Applications with no recent activity and no active sign from maintainer may be
flagged in apps.toml
with the package-not-maintained
antifeature tag to
signify that the app is inactive and may slowly become outdated with respect to
the upstream, or with respect to good packaging practices. It does not mean
that the app is not working anymore.
Feel free to contact the app group if you feel like taking over the maintenance of a currently unmaintained app!
graveyard.toml
This file is for apps that are long-term not-working and unlikely to be ever revived.