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

Add 'configure-the-server'

Browse Source
This commit is contained in:
PLUJA 2020-09-27 09:59:08 +02:00 committed by GitHub
parent f25bcac00b
commit 6007c2d16e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
SELF-HOSTING.md
View File

@ -12,6 +12,7 @@ When you self-host you make internet stronger and more censorship resistant. If
* [Docker Installation](#docker) * [Docker Installation](#docker)
* [Manual Installation](#manual-installation) * [Manual Installation](#manual-installation)
* [Nginx and HTTPS](#nginx-set-up-and-HTTPS) * [Nginx and HTTPS](#nginx-set-up-and-HTTPS)
* [Configure the server](#configrue-the-server)
* [Update](#updating-the-server) * [Update](#updating-the-server)
* [Others](#other-configurations) * [Others](#other-configurations)
@ -215,6 +216,22 @@ Now we will run certbot and we need to tell that we run an nginx server. Here yo
[Follow this instructions to install certbot and generate an ssl certificate so your server can use HTTPS](https://certbot.eff.org/lets-encrypt/ubuntufocal-nginx) [Follow this instructions to install certbot and generate an ssl certificate so your server can use HTTPS](https://certbot.eff.org/lets-encrypt/ubuntufocal-nginx)
## 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:
* **serverName**: Name of the server. Format: `example.com`
* **nitterInstance**: Nitter instance that will be used when fetching Twitter content. Format must be `https://<NitterInstance.tld>/`
* **maxInstanceUsers**: Max users on the instance. When set to `0` it closes registrations.
* **serverLocation**: Location of the server.
* **restrictPublicUsage**: When set to `false` the instance allows non-registered users to use some routes (i.e /watch?v=..., /ytsearch, /channel...). See [this section](https://github.com/pluja/Yotter/blob/dev-indep/SELF-HOSTING.md#removing-log-in-restrictions)
* **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.
* **donation_url**: Adds a link to a donation method for the instance.
## Updating the server ## Updating the server
Updating the server should always be pretty easy. These steps need to be run on the Yotter folder and with the python virtual env activated. Updating the server should always be pretty easy. These steps need to be run on the Yotter folder and with the python virtual env activated.