From 2cd36a7df87e068b6f0a0c1fc93a17ddc7abda02 Mon Sep 17 00:00:00 2001 From: pluja Date: Fri, 4 Sep 2020 08:26:36 +0200 Subject: [PATCH] Update readme --- README.md | 12 +++++++++++- yotter-config.json | 4 +--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1a6078b..80ba550 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/yotter-config.json b/yotter-config.json index 1c0a6dd..bf9d1d0 100644 --- a/yotter-config.json +++ b/yotter-config.json @@ -1,6 +1,4 @@ { "nitterInstance": "https://nitter.net/", - "registrations": true, - "maxInstanceUsers": 1, - "proxyAll": true + "maxInstanceUsers": 1 } \ No newline at end of file