2018-07-01 03:57:16 -04:00
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
- Copy this app before working on it.
2020-01-28 00:30:10 -05:00
- Edit the `conf/nginx.conf` file to match app prerequisites.
- Edit the `manifest.json` with app specific info.
2018-07-01 03:57:16 -04:00
- Edit the `install` , `upgrade` , `remove` , `backup` , and `restore` scripts.
2020-04-25 08:19:54 -04:00
- Using the [script helpers documentation. ](https://yunohost.org/#/packaging_apps_helpers )
2018-07-01 03:57:16 -04:00
- Add a `LICENSE` file for the package.
2020-01-28 00:30:10 -05:00
- Edit `README.md` and `README_fr.md` .
2018-07-01 03:57:16 -04:00
2017-02-04 03:58:08 -05:00
# Example app for YunoHost
2017-02-03 15:12:24 -05:00
2019-01-20 18:58:34 -05:00
[](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP)
2018-06-28 16:05:35 -04:00
[](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
2017-02-03 15:12:24 -05:00
2019-01-27 18:21:25 -05:00
*[Lire ce readme en français.](./README_fr.md)*
2020-01-28 00:30:10 -05:00
> *This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2014-10-20 12:55:53 -04:00
2018-06-28 16:05:35 -04:00
## Overview
Quick description of this app.
**Shipped version:** 1.0
## Screenshots
2020-01-28 00:30:10 -05:00
2018-06-28 16:05:35 -04:00
## Demo
2020-01-28 00:30:10 -05:00
* [Official demo ](Link to a demo site for this app. )
2018-06-28 16:05:35 -04:00
## Configuration
2020-01-28 00:30:10 -05:00
How to configure this app: From an admin panel, a plain file with SSH, or any other way.
2018-06-28 16:05:35 -04:00
## Documentation
* Official documentation: Link to the official documentation of this app
2018-08-08 17:04:20 -04:00
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
2018-06-28 16:05:35 -04:00
## YunoHost specific features
2020-01-28 00:30:10 -05:00
#### Multi-user support
2018-06-28 16:05:35 -04:00
2018-07-01 03:57:16 -04:00
Are LDAP and HTTP auth supported?
Can the app be used by multiple users?
2018-06-28 16:05:35 -04:00
#### Supported architectures
2020-01-28 00:30:10 -05:00
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
2019-05-02 14:18:52 -04:00
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
2018-06-28 16:05:35 -04:00
## Limitations
* Any known limitations.
2018-08-08 17:04:20 -04:00
## Additional information
2018-06-28 16:05:35 -04:00
2020-01-28 00:30:10 -05:00
* Other info you would like to add about this app.
2018-06-28 16:05:35 -04:00
2020-01-28 00:30:10 -05:00
**More info on the documentation page:**
2014-10-20 13:36:04 -04:00
https://yunohost.org/packaging_apps
2017-02-03 15:12:24 -05:00
2018-06-28 16:05:35 -04:00
## Links
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
2020-01-28 00:30:10 -05:00
* App website: Link to the official website of this app.
* Upstream app repository: Link to the official repository of the upstream app.
2018-06-28 16:05:35 -04:00
* YunoHost website: https://yunohost.org/
---
2020-01-28 00:30:10 -05:00
Developer info
2018-06-28 16:05:35 -04:00
----------------
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
2020-01-28 00:30:10 -05:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing ).
2017-02-03 15:12:24 -05:00
2018-06-28 16:05:35 -04:00
To try the testing branch, please proceed like that.
```
2018-07-01 04:11:12 -04:00
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
2018-06-28 16:05:35 -04:00
or
2018-07-01 04:11:12 -04:00
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
2018-06-28 16:05:35 -04:00
```
