X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=a55c7930f4a1539949f200957f6826e7d03efd5f;hb=7cf88d098adb543074f85be9c874ee9453371de9;hp=8d2a4da11610021a26fa1424817d8da4ee601650;hpb=57c36b277e68b764dd34cb2e449f6e2ca3d1e9b6;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/production.md b/support/doc/production.md index 8d2a4da11..a55c7930f 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -5,7 +5,8 @@ ## Installation -Please don't install PeerTube for production on a small device behind a low bandwidth connection (example: a Raspberry PI behind your ADSL link) because it could slow down the fediverse. See the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) for more information. +Please don't install PeerTube for production on a device behind a low bandwidth connection (example: your ADSL link). +If you want information about the appropriate hardware to run PeerTube, please see the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube). ### Dependencies @@ -38,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: @@ -74,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 @@ -95,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). @@ -112,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 ``` @@ -133,6 +147,21 @@ On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated $ 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** + +``` +$ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/ +$ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf +``` + +Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO +scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client +links as we often encounter in a video server. + ### systemd If your OS uses systemd, copy the configuration template: @@ -141,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 @@ -167,14 +196,12 @@ $ sudo systemctl start peertube $ sudo journalctl -feu peertube ``` -### FreeBSD - -If you're using FreeBSD, copy the startup script and update rc.conf: +**FreeBSD** +On FreeBSD, copy the startup script and update rc.conf: ``` -$ sudo cp /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/ -$ sudo chmod +x /usr/local/etc/rc.d/peertube -$ sudo echo peertube_enable="YES" >> /etc/rc.conf +$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/ +$ sudo sysrc peertube_enable="YES" ``` Run: @@ -183,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 @@ -192,12 +240,15 @@ logs. You can set another password with: $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root ``` +Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`, +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 @@ -220,7 +271,7 @@ Make a SQL backup ``` $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \ cd /var/www/peertube && sudo -u peertube mkdir -p backup && \ - sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH" + sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null ``` Fetch the latest tagged version of Peertube: @@ -304,8 +355,8 @@ Change `peertube-latest` destination to the previous version and restore your SQ ``` $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \ - cd /var/www/peertube && unlink ./peertube-latest && \ + cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \ sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \ - pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH" + sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \ sudo systemctl restart peertube ```