# Production guide
+ * [Installation](#installation)
+ * [Upgrade](#upgrade)
+
## Installation
+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
-Create a `peertube` user with `/home/peertube` home:
+Create a `peertube` user with `/var/www/peertube` home:
+
+```
+$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
+```
+
+Set its password:
+```
+$ sudo passwd peertube
+```
+
+**On FreeBSD**
```
-$ sudo useradd -m -d /home/peertube -s /bin/bash -p peertube peertube
+$ 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 production database and peertube user:
+Create the production database and a peertube user inside PostgreSQL:
```
$ sudo -u postgres createuser -P peertube
-$ sudo -u postgres createdb -O peertube peertube_prod
+```
+
+Here you should enter a password for PostgreSQL `peertube` user, that should be copied in `production.yaml` file.
+Don't just hit enter else it will be empty.
+
+```
+$ 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
+Fetch the latest tagged version of Peertube
```
-$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && \
- cd /home/peertube && \
- sudo -u peertube mkdir config storage versions && \
- cd versions && \
- sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
- sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip && \
- cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest && \
- cd ./peertube-latest && sudo -u peertube yarn install --production --pure-lockfile
+$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && echo "Latest Peertube version is $VERSION"
+```
+
+Open the peertube directory, create a few required directories
+```
+$ cd /var/www/peertube
+$ sudo -u peertube mkdir config storage versions
+```
+
+Download the latest version of the Peertube client, unzip it and remove the zip
+```
+$ cd /var/www/peertube/versions
+$ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
+$ sudo -u peertube unzip -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
+```
+
+Install Peertube:
+```
+$ cd /var/www/peertube
+$ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
+$ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
```
### 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 config/default.yaml
+```
+
+Now copy the production example configuration:
```
-$ cd /home/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
+$ 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.
+and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
+Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
+
+**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
+We only provide official configuration files for Nginx.
+
Copy the nginx configuration template:
```
-$ sudo cp /home/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
+$ 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}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
```
Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
$ sudo vim /etc/nginx/sites-available/peertube
```
-If you want to set https with Let's Encrypt please follow the steps of [this guide](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-16-04).
-
-An example of the nginx configuration could be:
+Activate the configuration file:
```
-server {
- listen 80;
- listen [::]:80;
- server_name peertube.example.com;
+$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
+```
- access_log /var/log/nginx/peertube.example.com.access.log;
- error_log /var/log/nginx/peertube.example.com.error.log;
+To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
- rewrite ^ https://$server_name$request_uri? permanent;
-}
+```
+$ sudo systemctl stop nginx
+$ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
+$ sudo systemctl reload nginx
+```
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name peertube.example.com;
+Now you have the certificates you can reload nginx:
- # For example with Let's Encrypt
- ssl_certificate /etc/letsencrypt/live/peertube.example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/peertube.example.com/privkey.pem;
- ssl_trusted_certificate /etc/letsencrypt/live/peertube.example.com/chain.pem;
+```
+$ sudo systemctl reload nginx
+```
- access_log /var/log/nginx/peertube.example.com.access.log;
- error_log /var/log/nginx/peertube.example.com.error.log;
+Certbot should have installed a cron to automatically renew your certificate.
+Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:
- location ^~ '/.well-known/acme-challenge' {
- default_type "text/plain";
- root /var/www/certbot;
- }
+```
+$ # Replace authenticator = standalone by authenticator = webroot
+$ # Add webroot_path = /var/www/certbot
+$ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
+```
- location ~ ^/client/(.*\.(js|css|woff2|otf|ttf|woff|eot))$ {
- add_header Cache-Control "public, max-age=31536000, immutable";
+**FreeBSD**
+On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
- alias /home/peertube/peertube-latest/client/dist/$1;
- }
+```
+$ sudo pkg install dehydrated
+```
- location ~ ^/static/(thumbnails|avatars)/(.*)$ {
- add_header Cache-Control "public, max-age=31536000, immutable";
+### TCP/IP Tuning
- alias /home/peertube/storage/$1/$2;
- }
+**On Linux**
- location / {
- proxy_pass http://localhost:9000;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header Host $host;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+```
+$ 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
+```
- # For the video upload
- client_max_body_size 8G;
- proxy_connect_timeout 600;
- proxy_send_timeout 600;
- proxy_read_timeout 600;
- send_timeout 600;
- }
+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.
- # Bypass PeerTube webseed route for better performances
- location /static/webseed {
- if ($request_method = 'OPTIONS') {
- add_header 'Access-Control-Allow-Origin' '*';
- add_header 'Access-Control-Allow-Methods' 'GET, OPTIONS';
- add_header 'Access-Control-Allow-Headers' 'Range,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
- add_header 'Access-Control-Max-Age' 1728000;
- add_header 'Content-Type' 'text/plain charset=UTF-8';
- add_header 'Content-Length' 0;
- return 204;
- }
+### systemd
- if ($request_method = 'GET') {
- add_header 'Access-Control-Allow-Origin' '*';
- add_header 'Access-Control-Allow-Methods' 'GET, OPTIONS';
- add_header 'Access-Control-Allow-Headers' 'Range,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
+If your OS uses systemd, copy the configuration template:
- # Don't spam access log file with byte range requests
- access_log off;
- }
+```
+$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+```
- alias /home/peertube/storage/videos;
- }
+Check the service file (PeerTube paths and security directives):
- # Websocket tracker
- location /tracker/socket {
- # Peers send a message to the tracker every 15 minutes
- # Don't close the websocket before this time
- proxy_read_timeout 1200s;
- proxy_set_header Upgrade $http_upgrade;
- proxy_set_header Connection "upgrade";
- proxy_http_version 1.1;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- proxy_set_header Host $host;
- proxy_pass http://localhost:9000;
- }
-}
+```
+$ sudo vim /etc/systemd/system/peertube.service
```
-Activate the configuration file:
+Tell systemd to reload its config:
```
-$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
-$ sudo systemctl reload nginx
+$ sudo systemctl daemon-reload
```
-### Systemd
-
-Copy the nginx configuration template:
+If you want to start PeerTube on boot:
```
-$ sudo cp /home/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+$ sudo systemctl enable peertube
```
-Update the service file:
+Run:
```
-$ sudo vim /etc/systemd/system/peertube.service
+$ sudo systemctl start peertube
+$ sudo journalctl -feu peertube
```
-It should look like this:
+**FreeBSD**
+On FreeBSD, copy the startup script and update rc.conf:
```
-[Unit]
-Description=PeerTube daemon
-After=network.target
+$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
+$ sudo sysrc peertube_enable="YES"
+```
-[Service]
-Type=simple
-Environment=NODE_ENV=production
-Environment=NODE_CONFIG_DIR=/home/peertube/config
-User=peertube
-Group=peertube
-ExecStart=/usr/bin/npm start
-WorkingDirectory=/home/peertube/peertube-latest
-StandardOutput=syslog
-StandardError=syslog
-SyslogIdentifier=peertube
-Restart=always
+Run:
-[Install]
-WantedBy=multi-user.target
+```
+$ sudo service peertube start
```
+### OpenRC
-Tell systemd to reload its config:
+If your OS uses OpenRC, copy the service script:
```
-$ sudo systemctl daemon-reload
+$ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
```
If you want to start PeerTube on boot:
```
-$ sudo systemctl enable peertube
+$ sudo rc-update add peertube default
```
-### Run
+Run and print last logs:
```
-$ sudo systemctl start peertube
-$ sudo journalctl -feu peertube
+$ 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
-logs. You can set another password with:
+The administrator password is automatically generated and can be found in the PeerTube
+logs (path defined in `production.yaml`). You can also set another password with:
```
-$ cd /home/peertube/peertube-latest && NODE_ENV=production npm run reset-password -- -u root
+$ 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:
+
+ * 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
+### PeerTube instance
+
+**Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
+
+#### Auto
+
+The password it asks is PeerTube's database user password.
+
+```
+$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
```
-$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && \
- cd /home/peertube/versions && \
+
+#### Manually
+
+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 -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
+```
+
+Fetch the latest tagged version of Peertube:
+
+```
+$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && echo "Latest Peertube version is $VERSION"
+```
+
+Download the new version and unzip it:
+
+```
+$ cd /var/www/peertube/versions && \
sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
- sudo -u peertube unzip -o peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip && \
- cd ../ && sudo rm ./peertube-latest && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest && \
- cd ./peertube-latest && sudo -u peertube yarn install --production --pure-lockfile && \
+ sudo -u peertube unzip -o peertube-${VERSION}.zip && \
+ sudo -u peertube rm peertube-${VERSION}.zip
+```
+
+Install node dependencies:
+
+```
+$ cd /var/www/peertube/versions/peertube-${VERSION} && \
+ sudo -H -u peertube yarn install --production --pure-lockfile
+```
+
+Copy new configuration defaults values and update your configuration file:
+
+```
+$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
+$ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
+```
+
+Change the link to point to the latest version:
+
+```
+$ cd /var/www/peertube && \
+ sudo unlink ./peertube-latest && \
+ 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:
+
+```
+$ 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?
+
+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 && sudo -u peertube unlink ./peertube-latest && \
+ sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
+ sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
sudo systemctl restart peertube
```