mirror of
https://github.com/YunoHost-Apps/overleaf_ynh.git
synced 2024-09-03 19:56:27 +02:00
66 lines
2.7 KiB
Markdown
66 lines
2.7 KiB
Markdown
|
# Example app pour YunoHost
|
||
|
|
|
||
|
|
[](https://dash.yunohost.org/appci/app/example)  
|
||
|
|
[](https://install-app.yunohost.org/?app=example)
|
||
|
|
|
||
|
|
*[Read this readme in english.](./README.md)*
|
||
|
|
*[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.*
|
||
|
|
|
||
|
|
## Vue d'ensemble
|
||
|
|
|
||
|
|
Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)
|
||
|
|
|
||
|
|
**Version incluse:** 1.0~ynh1
|
||
|
|
|
||
|
|
**Démo:** https://demo.example.com
|
||
|
|
|
||
|
|
|
||
|
|
## Captures d'écran
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Avertissements / informations importantes
|
||
|
|
|
||
|
|
* 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 ?
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Documentations et ressources
|
||
|
|
|
||
|
|
* Site official de l'app : https://example.com
|
||
|
|
* Documentation officielle utilisateur: https://yunohost.org/apps
|
||
|
|
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps
|
||
|
|
* Dépôt de code officiel de l'app: https://some.forge.com/example/example
|
||
|
|
* Documentation YunoHost pour cette app: https://yunohost.org/app_example
|
||
|
|
* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues
|
||
|
|
|
||
|
|
## Informations pour les développeurs
|
||
|
|
|
||
|
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||
|
|
|
||
|
|
Pour essayer la branche testing, procédez comme suit.
|
||
|
|
```
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps
|