mirror of
https://github.com/YunoHost-Apps/sutom_ynh.git
synced 2024-09-03 20:26:15 +02:00
84 lines
3.3 KiB
Markdown
84 lines
3.3 KiB
Markdown
|
|
||
|
|
# Packaging your an app, starting from this example
|
||
|
|
|
||
|
|
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) 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.](https://yunohost.org/packaging_apps_helpers)
|
||
|
|
- 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
|
||
|
|
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
<!--
|
||
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||
|
|
It shall NOT be edited by hand.
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Example app for YunoHost
|
||
|
|
|
||
|
|
[](https://dash.yunohost.org/appci/app/example)  
|
||
|
|
[](https://install-app.yunohost.org/?app=example)
|
||
|
|
|
||
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
|
|
||
|
|
> *This package allows you to install example 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.*
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
|
||
|
|
|
||
|
|
**Shipped version:** 1.0~ynh1
|
||
|
|
|
||
|
|
**Demo:** https://demo.example.com
|
||
|
|
|
||
|
|
|
||
|
|
## 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://example.com
|
||
|
|
* Official user documentation: https://yunohost.org/apps
|
||
|
|
* Official admin documentation: https://yunohost.org/packaging_apps
|
||
|
|
* Upstream app code repository: https://some.forge.com/example/example
|
||
|
|
* YunoHost documentation for this app: https://yunohost.org/app_example
|
||
|
|
* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
|
||
|
|
|
||
|
|
## Developer info
|
||
|
|
|
||
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||
|
|
|
||
|
|
To try the testing branch, please proceed like that.
|
||
|
|
```
|
||
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||
|
|
or
|
||
|
|
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
|