diff --git a/README.md b/README.md index 7c16559..7bb25f6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ It shall NOT be edited by hand. # Zerotier UI for YunoHost -[![Integration level](https://dash.yunohost.org/integration/ztncui.svg)](https://dash.yunohost.org/appci/app/ztncui) ![](https://ci-apps.yunohost.org/ci/badges/ztncui.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ztncui.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/ztncui.svg)](https://dash.yunohost.org/appci/app/ztncui) ![Working status](https://ci-apps.yunohost.org/ci/badges/ztncui.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ztncui.maintain.svg) + [![Install Zerotier UI with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ztncui) *[Lire ce readme en français.](./README_fr.md)* @@ -22,11 +23,9 @@ It allows you to take control of your own ZeroTier network without relying on th **Shipped version:** 20220103~ynh4 - - ## Screenshots -![](./doc/screenshots/screenshot.jpg) +![Screenshot of Zerotier UI](./doc/screenshots/screenshot.jpg) ## Disclaimers / important information @@ -39,22 +38,27 @@ It allows you to take control of your own ZeroTier network without relying on th * LDAP and HTTP auth are not supported. * Multiple users can use the app, you have to add them manually in `/opt/key-networks/ztncui/src/etc/passwd`, see ztncui's documentation. +## :red_circle: Antifeatures + +- **Non-free dependencies**: Relies on software dependencies that are not free in order to run. + ## Documentation and resources -* Official app website: https://key-networks.com/ztncui/ -* Upstream app code repository: https://github.com/key-networks/ztncui -* YunoHost documentation for this app: https://yunohost.org/app_ztncui -* Report a bug: https://github.com/YunoHost-Apps/ztncui_ynh/issues +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing --debug or sudo yunohost app upgrade ztncui -u https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 2a64e17..1b99d7a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,15 +1,20 @@ + + # Zerotier UI pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/ztncui.svg)](https://dash.yunohost.org/appci/app/ztncui) ![](https://ci-apps.yunohost.org/ci/badges/ztncui.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ztncui.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/ztncui.svg)](https://dash.yunohost.org/appci/app/ztncui) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/ztncui.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/ztncui.maintain.svg) + [![Installer Zerotier UI avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ztncui) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Zerotier UI 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.* +> *Ce package vous permet d’installer Zerotier UI 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 +## Vue d’ensemble ztncui is a web user interface for a standalone ZeroTier network controller. It allows you to take control of your own ZeroTier network without relying on the publisher's cloud-based controller. @@ -18,11 +23,9 @@ It allows you to take control of your own ZeroTier network without relying on th **Version incluse :** 20220103~ynh4 +## Captures d’écran - -## Captures d'écran - -![](./doc/screenshots/screenshot.jpg) +![Capture d’écran de Zerotier UI](./doc/screenshots/screenshot.jpg) ## Avertissements / informations importantes @@ -35,22 +38,27 @@ It allows you to take control of your own ZeroTier network without relying on th * LDAP and HTTP auth are not supported. * Multiple users can use the app, you have to add them manually in `/opt/key-networks/ztncui/src/etc/passwd`, see ztncui's documentation. +## :red_circle: Fonctions indésirables + +- **Non-free dependencies**: Relies on software dependencies that are not free in order to run. + ## Documentations et ressources -* Site officiel de l'app : https://key-networks.com/ztncui/ -* Dépôt de code officiel de l'app : https://github.com/key-networks/ztncui -* Documentation YunoHost pour cette app : https://yunohost.org/app_ztncui -* Signaler un bug : https://github.com/YunoHost-Apps/ztncui_ynh/issues +* Site officiel de l’app : +* Dépôt de code officiel de l’app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing --debug ou sudo yunohost app upgrade ztncui -u https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file diff --git a/check_process b/check_process index 2683486..479cd4d 100644 --- a/check_process +++ b/check_process @@ -3,13 +3,13 @@ ;; Test complet ; pre-install - sudo yunohost app install https://github.com/tituspijean/zerotier_ynh --force + sudo yunohost app install https://github.com/YunoHost-Apps/zerotier_ynh --force ; Manifest domain="domain.tld" path="/" admin="john" is_public=1 - password="pass" + password="DaB3estPassw0rd" ; Checks pkg_linter=1 setup_sub_dir=0 @@ -26,4 +26,4 @@ ;;; Upgrade options ; commit=CommitHash name=Name and date of the commit. - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& + manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=DaB3estPassw0rd&port=666&