diff --git a/README.md b/README.md index d536b73..e683831 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,36 @@ -# ZeroTier network controller user interface for YunoHost + -[![Integration level](https://dash.yunohost.org/integration/ztncui.svg)](https://dash.yunohost.org/appci/app/ztncui) -[![Install ztncui with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ztncui) +# 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) +[![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)* -> *This package allow you to install ztncui quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install Zerotier UI 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 -ztncui is a web user interface for a standalone ZeroTier network controller. It requires the ZeroTier app for YunoHost. -**Shipped version:** 0.5.8 +ZeroTier network controller user interface -## Screenshots +**Shipped version:** 20210310~ynh1 -![](https://key-networks.com/images/ztncui/07-networks-list.png) -## Configuration -No particular configuration is needed after initial installation. +## Documentation and resources -## Documentation +* 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 documentation: https://key-networks.com/ztncui/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. +## Developer info -## YunoHost specific features - -#### Multi-users support - - * No LDAP and HTTP auth supported. - * Can the app be used by multiple users? Yes, you have to add them manually in `/opt/key-networks/ztncui/src/etc/passwd`, see ztncui documentation. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ztncui%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/ztncui/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ztncui%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ztncui/) - -## Limitations - -* [ZeroTier for YunoHost](https://github.com/YunoHost-Apps/zerotier_ynh) has to be installed beforehand. - -## Additional information - -* Other information you would add about this application - -**More information on the documentation page:** -https://yunohost.org/packaging_apps - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/ztncui_ynh/issues - * App website: https://key-networks.com/ztncui/ - * Upstream app repository: https://github.com/key-networks/ztncui - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing). +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. ``` @@ -68,3 +38,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/ztncui_ynh/tree/testi 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 diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..05e1318 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,38 @@ +# 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) +[![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.* + +## Vue d'ensemble + +Interface utilisateur pour le contrôleur de réseau ZeroTier + +**Version incluse :** 20210310~ynh1 + + + +## 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 + +## 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. +``` +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