c07802d4ef
example_ynh readme reworked
3 KiB
3 KiB
Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
- Copy this app before working on it.
- Edit the
conf/nginx.conf
file to match app prerequisites. - Edit the
manifest.json
with app specific info. - Edit the
install
,upgrade
,remove
,backup
, andrestore
scripts.- Using the script helpers documentation.
- Add a
LICENSE
file for the package. - Edit
README.md
andREADME_fr.md
.
Example app for YunoHost
This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.
Overview
Quick description of this app.
Shipped version: 1.0
Screenshots
![](Link to a screenshot of this app.)
Demo
- [Official demo](Link to a demo site for this app.)
Configuration
How to configure this app: From an admin panel, a plain file with SSH, or any other way.
Documentation
- Official documentation: Link to the official documentation of this app
- YunoHost documentation: If specific documentation is needed, feel free to contribute.
YunoHost specific features
Multi-user support
Are LDAP and HTTP auth supported? Can the app be used by multiple users?
Supported architectures
Limitations
- Any known limitations.
Additional information
- Other info you would like to add about this app.
More info on the documentation page:
https://yunohost.org/packaging_apps
Links
- Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
- App website: Link to the official website of this app.
- Upstream app repository: Link to the official repository of the upstream app.
- YunoHost website: https://yunohost.org/
Developer info
Only if you want to use a testing branch for coding, instead of merging directly into master. 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/REPLACEBYYOURAPP_ynh/tree/testing --debug
or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug