X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=6febaba5d4e79694bc1fa8f332d17fde3264b9c5;hb=ec903c010ecc54ec2acad0bf2cf10e7fbf6a0fa2;hp=14042cddffa665f6f6eda911cb53008fa620b683;hpb=66c3b7744c6c7a91b9538eb5a6e0ae07e0a5a6af;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/support/doc/production.md b/support/doc/production.md
index 14042cddf..6febaba5d 100644
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -1,15 +1,16 @@
 # Production guide
 
   * [Installation](#installation)
-  * [Upgrade](#upgrade) 
+  * [Upgrade](#upgrade)
 
 ## 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
 
@@ -24,13 +25,28 @@ Set its password:
 $ sudo passwd peertube
 ```
 
+**On FreeBSD**
+
+```
+$ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
+$ sudo passwd peertube
+```
+or use `adduser` to create it interactively.
+
 ### Database
 
 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:
+
+```
+$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
+$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
 ```
 
 ### Prepare PeerTube directory
@@ -51,7 +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
+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
@@ -68,6 +84,8 @@ $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.
 Then edit the `config/production.yaml` file according to your webserver
 configuration.
 
+**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
+
 ### Webserver
 
 We only provide official configuration files for Nginx.
@@ -78,6 +96,13 @@ 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/peertube.example.com/[peertube-domain]/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).
 
@@ -109,9 +134,29 @@ Now you have the certificates you can reload nginx:
 $ sudo systemctl reload nginx
 ```
 
-### Systemd
+**FreeBSD**
+On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
+
+```
+$ 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
 
-Copy the SystemD configuration template:
+If your OS uses systemd, copy the configuration template:
 
 ```
 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
@@ -136,13 +181,48 @@ If you want to start PeerTube on boot:
 $ sudo systemctl enable peertube
 ```
 
-### Run
+Run:
 
 ```
 $ sudo systemctl start peertube
 $ sudo journalctl -feu peertube
 ```
 
+**FreeBSD**
+On FreeBSD, copy the startup script and update 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:
+
+```
+$ 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
@@ -152,13 +232,29 @@ 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 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
@@ -168,7 +264,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:
@@ -190,7 +286,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:
@@ -208,20 +304,52 @@ $ cd /var/www/peertube && \
     sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
 ```
 
+### nginx
 
-Restart PeerTube:
+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"
 ```
-$ sudo systemctl restart peertube
+
+### systemd
+
+Check changes in systemd configuration:
+
+```
+$ 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? 
+### Things went wrong?
 
 Change `peertube-latest` destination to the previous version and restore your SQL backup:
 
 ```
 $ 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
 ```