Update readme

This commit is contained in:
pluja 2020-09-04 08:26:36 +02:00
parent 6153aa1b2a
commit 2cd36a7df8
2 changed files with 12 additions and 4 deletions

View File

@ -17,9 +17,12 @@ Yotter is possible thanks to several open-source projects that are listed on the
* [Screenshots](#screenshots)
* [Privacy and Security](#-privacy)
* [Self hosting](#-self-hosting)
* [Install & Test](#-test)
* Install & Test
* [Normal installation](#-test)
* [Docker installation](#using-docker)
* [Hosting on a server](#-hosting-on-a-server)
* [Update](#-updating-to-newer-versions)
* [Configure server](#configure-the-server)
* [Powered by](#-powered-by)
* [Donate](#-donate)
@ -153,6 +156,13 @@ A quick deployment
6. Done! You are on latest version.
> **See [CHANGELOG](CHANGELOG.md) for a list of changes.**
### 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.
Currently available config is:
* **nitterInstance**: Nitter instance that will be used when fetching Twitter content.
* **maxInstanceUsers**: Max users on the instance. When set to `0` it closes registrations.
### ⛽ Powered by:
* [Nitter](https://nitter.net/)
* [youtube-dl](https://github.com/ytdl-org/youtube-dl)

View File

@ -1,6 +1,4 @@
{
"nitterInstance": "https://nitter.net/",
"registrations": true,
"maxInstanceUsers": 1,
"proxyAll": true
"maxInstanceUsers": 1
}