# 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 because it could slow down the fediverse.**
+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.
### Dependencies
-Follow the steps of the [dependencies guide](dependencies.md).
+**Follow the steps of the [dependencies guide](dependencies.md).**
### PeerTube user
$ 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 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
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.
$ sudo vim /etc/nginx/sites-available/peertube
```
-Your Mileage May Vary, but what follows is an example of configuration for nginx with a certificate made via `certbot` ([other utilities exist](https://letsencrypt.org/docs/client-options/)):
-
-```
-server {
- listen 80;
- listen [::]:80;
- server_name peertube.example.com;
-
- access_log /var/log/nginx/peertube.example.com.access.log;
- error_log /var/log/nginx/peertube.example.com.error.log;
-
- rewrite ^ https://$server_name$request_uri? permanent;
-}
-
-server {
- listen 443 ssl http2;
- listen [::]:443 ssl http2;
- server_name peertube.example.com;
-
- # For example with Let's Encrypt (you need a certificate to run https)
- ssl_certificate /etc/letsencrypt/live/peertube.example.com/fullchain.pem;
- ssl_certificate_key /etc/letsencrypt/live/peertube.example.com/privkey.pem;
-
- # Security hardening (as of 11/02/2018)
- ssl_protocols TLSv1.3, TLSv1.2;# TLSv1.3 requires nginx >= 1.13.0 else use only TLSv1.2
- ssl_ciphers 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256';
- ssl_prefer_server_ciphers on;
- ssl_ecdh_curve secp384r1; # Requires nginx >= 1.1.0
- ssl_session_timeout 10m;
- ssl_session_cache shared:SSL:10m;
- ssl_session_tickets off; # Requires nginx >= 1.5.9
- ssl_stapling on; # Requires nginx >= 1.3.7
- ssl_stapling_verify on; # Requires nginx => 1.3.7
- resolver $DNS-IP-1 $DNS-IP-2 valid=300s;
- resolver_timeout 5s;
- add_header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload";
- add_header X-Frame-Options DENY;
- add_header X-Content-Type-Options nosniff;
- add_header X-XSS-Protection "1; mode=block";
- add_header X-Robots-Tag none;
-
- access_log /var/log/nginx/peertube.example.com.access.log;
- error_log /var/log/nginx/peertube.example.com.error.log;
-
- location ^~ '/.well-known/acme-challenge' {
- default_type "text/plain";
- root /var/www/certbot;
- }
-
- location ~ ^/client/(.*\.(js|css|woff2|otf|ttf|woff|eot))$ {
- add_header Cache-Control "public, max-age=31536000, immutable";
-
- alias /var/www/peertube/peertube-latest/client/dist/$1;
- }
-
- location ~ ^/static/(thumbnails|avatars)/(.*)$ {
- add_header Cache-Control "public, max-age=31536000, immutable";
-
- alias /var/www/peertube/storage/$1/$2;
- }
-
- 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;
-
- # For the video upload
- client_max_body_size 2G;
- proxy_connect_timeout 600;
- proxy_send_timeout 600;
- proxy_read_timeout 600;
- send_timeout 600;
- }
-
- # Bypass PeerTube webseed route for better performances
- location /static/webseed {
- # Clients usually have 4 simultaneous webseed connections, so the real limit is 3MB/s per client
- limit_rate 800k;
-
- 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;
- }
-
- 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';
-
- # Don't spam access log file with byte range requests
- access_log off;
- }
-
- alias /var/www/peertube/storage/videos;
- }
-
- # 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;
- }
-}
-```
-
-To generate the certificate for your domain as required to make https work, you have two alternatives (note that the second command modifies itself the Nginx configuration to point the concerned server blocks to its certificate):
-
-```
-$ sudo certbot --authenticator standalone certonly -d peertube.example.com && nginx -t && systemctl reload nginx
-```
-
-```
-$ sudo certbot --authenticator standalone --installer nginx --post-hook "nginx -t && systemctl reload nginx"
-```
-
-Remember your certificate will expire in 90 days, and thus needs renewal.
-
Activate the configuration file:
```
$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
+```
+
+To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
+
+```
+$ sudo systemctl stop nginx
+$ sudo vim /etc/nginx/sites-available/peertube # Comment ssl_certificate and ssl_certificate_key lines
+$ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx"
+$ sudo vim /etc/nginx/sites-available/peertube # Uncomment ssl_certificate and ssl_certificate_key lines
$ sudo systemctl reload nginx
```
-### Systemd
+Remember your certificate will expire in 90 days, and thus needs renewal.
-Copy the SystemD configuration template:
+Now you have the certificates you can reload nginx:
```
-$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+$ sudo systemctl reload nginx
```
-Update the service file:
+**FreeBSD**
+On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
```
-$ sudo vim /etc/systemd/system/peertube.service
+$ sudo pkg install dehydrated
```
-It should look like this:
+### systemd
+
+If your OS uses systemd, copy the configuration template:
```
-[Unit]
-Description=PeerTube daemon
-After=network.target
+$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+```
-[Service]
-Type=simple
-Environment=NODE_ENV=production
-Environment=NODE_CONFIG_DIR=/var/www/peertube/config
-User=peertube
-Group=peertube
-ExecStart=/usr/bin/npm start
-WorkingDirectory=/var/www/peertube/peertube-latest
-StandardOutput=syslog
-StandardError=syslog
-SyslogIdentifier=peertube
-Restart=always
+Update the service file:
-[Install]
-WantedBy=multi-user.target
+```
+$ sudo vim /etc/systemd/system/peertube.service
```
$ sudo systemctl enable peertube
```
-### Run
+Run:
```
$ sudo systemctl start peertube
$ sudo journalctl -feu peertube
```
+### FreeBSD
+
+If you're using 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
+```
+
+Run:
+
+```
+$ sudo service peertube start
+```
+
### Administrator
The administrator password is automatically generated and can be found in the
$ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
```
+### 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 code
+
+**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
-$ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
-$ sudo systemctl restart peertube && sudo journalctl -fu peertube
+$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
```
#### Manually
```
$ 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:
```
$ cd /var/www/peertube && \
- sudo rm ./peertube-latest && \
+ 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
-Restart PeerTube:
+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"
```
-$ sudo systemctl restart peertube
+
+### 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 && rm ./peertube-latest && \
+ cd /var/www/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 systemctl restart peertube
projects / github / Chocobozzz / PeerTube.git / blobdiff