garage_ynh/README.md

85 lines
3.7 KiB
Markdown
Raw Normal View History

# Packaging an app, starting from this example
2021-05-10 15:52:42 +00:00
2022-06-06 17:45:13 +00:00
* 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
2021-05-10 15:52:42 +00:00
---
<!--
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.
-->
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
# Example app for YunoHost
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
*[Lire ce readme en français.](./README_fr.md)*
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
> *This package allows you to install Example app quickly and simply on a YunoHost server.
2021-05-10 15:52:42 +00:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
## Overview
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
### Features
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
- Laboris nisi ut aliquip ex ea commodo consequat ;
- Duis aute irure dolor in reprehenderit in voluptate ;
- Velit esse cillum dolore eu fugiat nulla pariatur ;
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
**Shipped version:** 1.0~ynh1
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
**Demo:** https://demo.example.com
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
## Screenshots
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
![Screenshot of Example app](./doc/screenshots/example.jpg)
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
## Disclaimers / important information
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
* 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...
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
* 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 ?
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
## Documentation and resources
2018-06-28 20:05:35 +00:00
2022-06-06 17:45:13 +00:00
* 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>
2018-06-28 20:05:35 +00:00
2020-08-02 13:41:28 +00:00
## Developer info
2018-06-28 20:05:35 +00:00
2021-05-10 15:52:42 +00:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
2018-06-28 20:05:35 +00:00
To try the testing branch, please proceed like that.
2022-06-06 17:45:13 +00:00
``` bash
2021-05-10 15:52:42 +00:00
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
2018-06-28 20:05:35 +00:00
or
2021-05-10 15:52:42 +00:00
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
2018-06-28 20:05:35 +00:00
```
2021-05-10 15:52:42 +00:00
2022-06-06 17:45:13 +00:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>