Merge branch 'release/v1.3.0' into develop
[oweals/peertube.git] / support / doc / production.md
index eb72985a33b3f98e8a7c28e0477322fa161a21e7..4f20cf140f39ae1f699ba166765a03eb2d0357f2 100644 (file)
@@ -134,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:
@@ -168,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:
@@ -193,12 +204,16 @@ 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