Go to file
2022-10-09 17:24:15 +02:00
.github Update updater.sh 2022-03-24 10:47:23 +01:00
conf Fix mistake 2022-10-09 15:14:52 +00:00
doc Markdown title ftw 2021-08-23 14:16:47 +02:00
scripts Fix virtualisation variable name 2022-10-09 17:24:15 +02:00
sources Merge pull request #29 from YunoHost/extra_files_dir 2017-06-25 16:39:50 +02:00
.gitignore [enh] Add a really simple gitignore 2016-04-26 15:26:27 +02:00
check_process WIP packaging 2022-07-30 14:02:57 +02:00
config_panel.toml.example Update config_panel.toml.example 2021-10-06 19:51:34 +02:00
LICENSE WIP packaging 2022-07-30 14:02:57 +02:00
manifest.json Fix virtualisation variable name 2022-10-09 17:24:15 +02:00
README.md Update README.md 2022-06-07 22:49:04 +02:00
README_fr.md Update README_fr.md 2022-06-07 22:48:00 +02:00

Packaging an app, starting from this example

Example app for YunoHost

Integration level Working status Maintenance status
Install Example app with YunoHost

Lire ce readme en français.

This package allows you to install Example app quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.


Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.


  • Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
  • Laboris nisi ut aliquip ex ea commodo consequat ;
  • Duis aute irure dolor in reprehenderit in voluptate ;
  • Velit esse cillum dolore eu fugiat nulla pariatur ;
  • Excepteur sint occaecat cupidatat non proident, sunt in culpa."

Shipped version: 1.0~ynh1

Demo: https://demo.example.com


Screenshot of Example app

Disclaimers / important information

  • Any known limitations, constrains or stuff not working, such as (but not limited to):

    • requiring a full dedicated domain ?
    • architectures not supported ?
    • not-working single-sign on or LDAP integration ?
    • the app requires an important amount of RAM / disk / .. to install or to work properly
    • etc...
  • Other infos that people should be aware of, such as:

    • any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
    • how to configure / administrate the application if it ain't obvious
    • upgrade process / specificities / things to be aware of ?
    • security considerations ?

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps