X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=16efe17c4b800758873bd7e07aca4a9fe396c14b;hb=9024bece9a51d3bc666ba94f272aaec186e3c278;hp=34d213ec628ec95a2d0321cf81afb38d65933c53;hpb=fb0e959dba088b7414926f7d11c53b1611a4ea7b;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/production.md b/support/doc/production.md index 34d213ec6..16efe17c4 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -5,11 +5,12 @@ ## 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.** +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 -Follow the steps of the [dependencies guide](dependencies.md). +**Follow the steps of the [dependencies guide](dependencies.md).** ### PeerTube user @@ -41,6 +42,13 @@ $ sudo -u postgres createuser -P peertube $ sudo -u postgres createdb -O peertube peertube_prod ``` +Then enable extensions PeerTube needs: + +``` +$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod +$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod +``` + ### Prepare PeerTube directory Fetch the latest tagged version of Peertube @@ -59,11 +67,7 @@ $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/down $ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip ``` -Install Peertube. If you're using CentOS7, do not forget to activate the devtoolset-6 software collection: -``` -$ scl enable devtool-6 bash -``` -And after that, follow the step as usual. Do not forget to exit the environment after installing Peertube. +Install Peertube: ``` $ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile @@ -130,6 +134,19 @@ On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated $ sudo pkg install dehydrated ``` +### TCP/IP Tuning + +**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: @@ -164,14 +181,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: @@ -189,15 +204,25 @@ 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 ``` -Now you can subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin +### 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/ ## Upgrade +### PeerTube instance + +**Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md + #### Auto (minor versions only) +The password it asks is PeerTube's database user password. + ``` -$ cd /var/www/peertube/peertube-latest/scripts && sudo -u peertube ./upgrade.sh -$ sudo systemctl restart peertube && sudo journalctl -fu peertube +$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh ``` #### Manually @@ -207,7 +232,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: @@ -229,7 +254,7 @@ Install node dependencies: ``` $ cd /var/www/peertube/versions/peertube-${VERSION} && \ - sudo -u peertube yarn install --production --pure-lockfile + sudo -H -u peertube yarn install --production --pure-lockfile ``` Copy new configuration defaults values and update your configuration file: @@ -247,10 +272,42 @@ $ cd /var/www/peertube && \ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest ``` +### nginx + +Check changes in nginx configuration: + +``` +$ cd /var/www/peertube/versions +$ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube" +``` + +### systemd + +Check changes in systemd configuration: -Restart PeerTube: ``` -$ sudo systemctl restart peertube +$ cd /var/www/peertube/versions +$ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service" +``` + +### Restart PeerTube + +If you changed your nginx configuration: + +``` +$ sudo systemctl reload nginx +``` + +If you changed your systemd configuration: + +``` +$ sudo systemctl daemon-reload +``` + +Restart PeerTube and check the logs: + +``` +$ sudo systemctl restart peertube && sudo journalctl -fu peertube ``` ### Things went wrong? @@ -259,8 +316,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 ```