X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=4f20cf140f39ae1f699ba166765a03eb2d0357f2;hb=07d02f6de885e3b9dafcab0080dca97d1c04e302;hp=fd29571596efb76b0b99cd3ad464f67ce1fc2638;hpb=80d7cf3a15c533d43e7e7f7a240d0eb89640e1c3;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/production.md b/support/doc/production.md index fd2957159..4f20cf140 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 @@ -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,12 +67,6 @@ $ 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 ``` -*If you're using CentOS7, do not forget to activate the devtoolset-7 software collection. -And after that, follow the step as usual. Do not forget to exit the environment after installing Peertube:* -``` -$ sudo scl enable devtoolset-7 bash -``` - Install Peertube: ``` $ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest @@ -132,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: @@ -166,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: @@ -191,16 +204,20 @@ 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/ + * Check [available CLI tools](/support/doc/tools.md) ## Upgrade -### PeerTube code +### PeerTube instance **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md @@ -219,7 +236,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: @@ -303,8 +320,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 ```