ztncui_ynh/README.md

<!--
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) ![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)

*[Read this README is other languages.](./ALL_README.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:** 20230311~ynh1

## Screenshots

![Screenshot of Zerotier UI](./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.

## :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 Store: <https://apps.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:

```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>