1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ztncui_ynh.git synced 2024-09-03 18:06:05 +02:00
ztncui_ynh/README.md
2022-01-15 15:08:01 +00:00

60 lines
No EOL
2.2 KiB
Markdown

<!--
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.
-->
# 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 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 allows you to take control of your own ZeroTier network without relying on the publisher's cloud-based controller.
**Shipped version:** 20220103~ynh3
## Screenshots
![](./doc/screenshots/screenshot.jpg)
## Disclaimers / important information
### Dependency
* [ZeroTier for YunoHost](https://github.com/YunoHost-Apps/zerotier_ynh) has to be installed beforehand.
### Multi-users support
* 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.
## 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
## 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.
```
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