diff --git a/README.md b/README.md index 3973afe..8d3bbcb 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,46 @@ -# PufferPanel app for YunoHost -PufferPanel Server + -- [Yunohost project](https://yunohost.org) -- [PufferPanel website](https://www.pufferpanel.com/) +# PufferPanel for YunoHost -![](http://i.imgur.com/YCy8Md2.png) +[![Integration level](https://dash.yunohost.org/integration/pufferpanel.svg)](https://dash.yunohost.org/appci/app/pufferpanel) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.maintain.svg) +[![Install PufferPanel with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pufferpanel) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install PufferPanel 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 + +Web-based Game Server Management System. + +**Shipped version:** 2.4.0~ynh1 -[![Install PufferPanel with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=pufferpanel) -### Installing guide +## Disclaimers / important information - App can be installed by YunoHost **admin web-interface** or by **running following command**: +- Admin username minimum length is 5 +## Documentation and resources - $ sudo yunohost app install https://github.com/YunoHost-Apps/pufferpanel_ynh - -### Server Location +* Official app website: https://www.pufferpanel.com/ +* Official admin documentation: https://docs.pufferpanel.com/en/latest/ +* Upstream app code repository: https://github.com/PufferPanel/PufferPanel +* YunoHost documentation for this app: https://yunohost.org/app_pufferpanel +* Report a bug: https://github.com/YunoHost-Apps/pufferpanel_ynh/issues -Server is installed on /var/lib/pufferd/servers/* +## Developer info -Command Exemple : +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing). - $ chmod -R 775 /var/lib/pufferd/servers/40b93af5-c378-4ec5-857e-5ff50b09170d - $ chown -R pufferd:pufferd /var/lib/pufferd/servers/40b93af5-c378-4ec5-857e-5ff50b09170d - - -### Upgrade this package: - - $ sudo yunohost app upgrade pufferpanel -u https://github.com/YunoHost-Apps/pufferpanel_ynh +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing --debug +or +sudo yunohost app upgrade pufferpanel -u https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing --debug +``` +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..c424021 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,42 @@ +# PufferPanel pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/pufferpanel.svg)](https://dash.yunohost.org/appci/app/pufferpanel) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.maintain.svg) +[![Installer PufferPanel avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pufferpanel) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer PufferPanel rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + + + +**Version incluse :** 2.4.0~ynh1 + + + +## Avertissements / informations importantes + +- Admin username minimum length is 5 +## Documentations et ressources + +* Site officiel de l'app : https://www.pufferpanel.com/ +* Documentation officielle de l'admin : https://docs.pufferpanel.com/en/latest/ +* Dépôt de code officiel de l'app : https://github.com/PufferPanel/PufferPanel +* Documentation YunoHost pour cette app : https://yunohost.org/app_pufferpanel +* Signaler un bug : https://github.com/YunoHost-Apps/pufferpanel_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing --debug +ou +sudo yunohost app upgrade pufferpanel -u https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file