Packaging your an app, starting from this example

Copy this app before working on it, using the 'Use this template' button on the Github repo.
Edit the manifest.json with app specific info.
Edit the install, upgrade, remove, backup, and restore scripts, and any relevant conf files in conf/.
- Using the script helpers documentation.
Add a LICENSE file for the package.
Edit doc/DISCLAIMER*.md
The README.md files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator

Cactus Comments for YunoHost

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

Overview

Cactus Comments is a federated comment system for the web, based on the Matrix protocol.

Shipped version: 0.7.1~ynh1

Demo: https://cactus.chat/demo/

Screenshots

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

Official app website: https://cactus.chat
Official documentation: https://cactus.chat/docs/getting-started/introduction/
Upstream app code repository: https://gitlab.com/cactus-comments
YunoHost documentation for this app: https://yunohost.org/app_cactus-comments
Report a bug: https://github.com/YunoHost-Apps/cactus-comments_ynh/issues

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/cactus-comments_ynh/tree/testing --debug
or
sudo yunohost app upgrade cactus-comments -u https://github.com/YunoHost-Apps/cactus-comments_ynh/tree/testing --debug

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

h3ndrik / cactus-comments_ynh