kavin/Yotter
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
PLUJA 2020-09-20 09:42:25 +02:00 committed by GitHub
parent 6a6b49bfcb
commit 4a09996278
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -17,6 +17,7 @@ Yotter is possible thanks to several open-source projects that are listed on the
* [Privacy and Security](#privacy)
* [Public instances](#public-instances)
* [Self hosting](https://github.com/ytorg/Yotter/blob/dev-indep/SELF-HOSTING.md)
* [Update the server](#update-the-server)
* [Configure server](#configure-the-server)
* [Contributing and contact](#contributing)
* [Powered by](#powered-by)
@ -74,6 +75,8 @@ I always recommend self-hosting, as you will be the only person with access to t
| https://yotter.xyz |Germany| Limited (50 users)|
| https://yotter.kavin.rocks/ |India| Limited (50 users)|
## Update the server
[SEE THIS FILE](https://github.com/ytorg/Yotter/blob/dev-indep/SELF-HOSTING.md#updating-the-server)
## Configure the server
You will find in the root folder of the project a file named `yotter-config.json`. This is the global config file for the Yotter server.
@ -86,6 +89,8 @@ Currently available config is:
* **nginxVideoStream**: Wether or not to use Nginx as streaming engine. It is recommended for public instances. [See this link]()
* **maintenance_mode**: Activates a message on the server warning users of maintenance mode.
* **show_admin_message**: Shows a message from the admin with title as `admin_message_title` and body as `admin_message`
* **admin_user**: Username of the admin user.
* **max_old_user_days**: Maximum days for a user to be inactive, otherwise will be deleted if admin uses the action.
# Contributing
Contributors are always welcome. You can help in many ways: Coding, organizing, designing, [donating](#donate), maintaining... You choose what you want to help with!