2021-10-06 00:20:05 +02:00
|
|
|
<!--
|
|
|
|
|
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.
|
|
|
|
|
-->
|
2019-12-15 16:09:28 +01:00
|
|
|
|
2021-10-06 00:20:05 +02:00
|
|
|
# Zerotier UI for YunoHost
|
|
|
|
|
|
|
|
|
|
[](https://dash.yunohost.org/appci/app/ztncui)  
|
|
|
|
|
[](https://install-app.yunohost.org/?app=ztncui)
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
|
2021-10-06 00:20:05 +02:00
|
|
|
> *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.*
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
2021-10-06 23:37:13 +02:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
2019-12-15 16:09:28 +01:00
|
|
|
|
2022-01-15 16:08:01 +01:00
|
|
|
**Shipped version:** 20220103~ynh3
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-10-06 23:37:13 +02:00
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
|
2021-10-06 00:20:05 +02:00
|
|
|
## Documentation and resources
|
2019-12-15 16:09:28 +01:00
|
|
|
|
2021-10-06 00:20:05 +02:00
|
|
|
* 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
|
2019-12-15 16:09:28 +01:00
|
|
|
|
2021-10-06 00:20:05 +02:00
|
|
|
## Developer info
|
2019-12-15 16:09:28 +01:00
|
|
|
|
2021-10-06 00:20:05 +02:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ztncui_ynh/tree/testing).
|
2019-12-15 16:09:28 +01:00
|
|
|
|
|
|
|
|
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
|
|
|
|
|
```
|
2021-10-06 00:20:05 +02:00
|
|
|
|
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
