2017-02-04 03:58:08 -05:00
|
|
|
# Example app for YunoHost
|
2017-02-03 15:12:24 -05:00
|
|
|
|
2017-02-04 03:58:08 -05:00
|
|
|
- [Yunohost project](https://yunohost.org)
|
|
|
|
|
- [Exemple app website](https://example.com)
|
2017-02-03 15:12:24 -05:00
|
|
|
|
2017-02-04 03:58:08 -05:00
|
|
|
Description of the app.
|
2014-10-20 12:55:53 -04:00
|
|
|
|
2016-06-13 16:25:00 -04:00
|
|
|
## Usage
|
2017-02-03 15:12:24 -05:00
|
|
|
- Fork this app before work on it.
|
2014-10-20 12:55:53 -04:00
|
|
|
- Edit `conf/nginx.conf` file to match application prerequisites.
|
2017-02-04 04:01:11 -05:00
|
|
|
- Edit `manifest.json` with application specific information.
|
|
|
|
|
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
|
2017-02-04 03:58:08 -05:00
|
|
|
- Add a `LICENSE` file for the package.
|
2017-02-04 04:01:11 -05:00
|
|
|
- Edit `README.md`.
|
2014-10-20 13:36:04 -04:00
|
|
|
|
|
|
|
|
**More information on the documentation page:**
|
|
|
|
|
https://yunohost.org/packaging_apps
|
2017-02-03 15:12:24 -05:00
|
|
|
|
|
|
|
|
**Upgrade this package:**
|
2017-02-04 03:58:08 -05:00
|
|
|
`sudo yunohost app upgrade --verbose example -u https://github.com/YunoHost-Apps/example_ynh`
|
2017-02-03 15:12:24 -05:00
|
|
|
|
|
|
|
|
**Multi-user:** Yes/No. How about the ldap and HTTP auth support.
|
