X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=9df79f870e6000358673db0ba6a2379437650b19;hb=0a0e0d082f778fca86ab73313c130ef92b5f840d;hp=4f20cf140f39ae1f699ba166765a03eb2d0357f2;hpb=432ebe8bddb407bfbe503b782d59b1ee4c0d6842;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/production.md b/support/doc/production.md index 4f20cf140..9df79f870 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -39,7 +39,7 @@ Create the production database and a peertube user inside PostgreSQL: ``` $ sudo -u postgres createuser -P peertube -$ sudo -u postgres createdb -O peertube peertube_prod +$ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod ``` Then enable extensions PeerTube needs: @@ -75,16 +75,23 @@ $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-l ### PeerTube configuration -Copy example configuration: +Copy the default configuration file that contains the default configuration provided by PeerTube. +You **must not** update this file. + +``` +$ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/default.yaml.example config/default.yaml +``` + +Now copy the production example configuration: ``` $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml ``` Then edit the `config/production.yaml` file according to your webserver -configuration. +configuration. Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`. -**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start. +**PeerTube does not support webserver host change**. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/#/maintain-tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors. ### Webserver @@ -96,6 +103,14 @@ Copy the nginx configuration template: $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube ``` +Then set the domain for the webserver configuration file. +Replace `[peertube-domain]` with the domain for the peertube server. + +``` +$ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube +$ sudo sed -i 's/${PEERTUBE_HOST}/localhost:9000/g' /etc/nginx/sites-available/peertube +``` + Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations. It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key). @@ -113,9 +128,7 @@ To generate the certificate for your domain as required to make https work you c ``` $ sudo systemctl stop nginx -$ sudo vim /etc/nginx/sites-available/peertube # Comment ssl_certificate and ssl_certificate_key lines -$ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx" -$ sudo vim /etc/nginx/sites-available/peertube # Uncomment ssl_certificate and ssl_certificate_key lines +$ sudo certbot certonly --standalone --post-hook "systemctl start nginx" $ sudo systemctl reload nginx ``` @@ -136,6 +149,8 @@ $ sudo pkg install dehydrated ### TCP/IP Tuning +A lot of your instance's raw performance is dependent on a properly tuned machine and more specifically, reverse-proxy. We provide support for Nginx and spent a lot of time putting sane defaults in it, but we strongly advise you to follow up with instructions in https://github.com/denji/nginx-tuning as needed. + **On Linux** ``` @@ -155,7 +170,7 @@ If your OS uses systemd, copy the configuration template: $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/ ``` -Update the service file: +Check the service file (PeerTube paths and security directives): ``` $ sudo vim /etc/systemd/system/peertube.service @@ -195,6 +210,27 @@ Run: $ sudo service peertube start ``` +### OpenRC + +If your OS uses OpenRC, copy the service script: + +``` +$ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/ +``` + +If you want to start PeerTube on boot: + +``` +$ sudo rc-update add peertube default +``` + +Run and print last logs: + +``` +$ sudo /etc/init.d/peertube start +$ tail -f /var/log/peertube/peertube.log +``` + ### Administrator The administrator password is automatically generated and can be found in the @@ -210,9 +246,8 @@ to your own administrator password, although it must be 6 characters or more. ### What now? Now your instance is up you can: - - * Subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin - * Add you instance to the public PeerTube instances index if you want to: https://instances.peertu.be/ + + * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/ * Check [available CLI tools](/support/doc/tools.md) ## Upgrade