X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=e711f09979f273304383004cb0c27eedeb443fb9;hb=fa66c9a601d69f6d57c956a3513e8bbed7ee9616;hp=b5e5dd9cffbcae91dc063fca9f21c60d07928edf;hpb=1185c246c591a0783dc0ab268bbd67eba1d46bb9;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/support/doc/production.md b/support/doc/production.md
index b5e5dd9cf..e711f0997 100644
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -1,281 +1,308 @@
 # 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 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://joinpeertube.org/en_US/faq#should-i-have-a-big-server-to-run-peertube).
 
-### Dependencies
+### :hammer: Dependencies
 
 Follow the steps of the [dependencies guide](dependencies.md).
 
-### PeerTube user
+### :construction_worker: PeerTube user
 
 Create a `peertube` user with `/var/www/peertube` home:
 
-```
+```bash
 $ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
 ```
 
 Set its password:
+```bash
+$ sudo passwd peertube
 ```
+
+**On FreeBSD**
+
+```bash
+$ 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
+### :card_file_box: Database
 
 Create the production database and a peertube user inside PostgreSQL:
 
-```
+```bash
+$ cd /var/www/peertube
 $ sudo -u postgres createuser -P peertube
-$ sudo -u postgres createdb -O peertube peertube_prod
 ```
 
-### Prepare PeerTube directory
+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.
 
-Fetch the latest tagged version of Peertube
+```bash
+$ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
 ```
+
+Then enable extensions PeerTube needs:
+
+```bash
+$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
+$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
+```
+
+### :page_facing_up: Prepare PeerTube directory
+
+Fetch the latest tagged version of Peertube
+```bash
 $ 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 && cd versions
+```bash
+$ cd /var/www/peertube
+$ sudo -u peertube mkdir config storage versions
+$ sudo -u peertube chmod 750 config/
 ```
 
 Download the latest version of the Peertube client, unzip it and remove the zip
-```
+```bash
+$ 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 peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
+$ sudo -u peertube unzip -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
 ```
 
-Install Peertube
-```
-$ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
+Install Peertube:
+```bash
+$ 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
+### :wrench: PeerTube configuration
 
-Copy example configuration:
+Copy the default configuration file that contains the default configuration provided by PeerTube.
+You **must not** update this file.
 
+```bash
+$ cd /var/www/peertube
+$ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
 ```
-$ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
+
+Now copy the production example configuration:
+
+```bash
+$ 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
+### :truck: Webserver
+
+We only provide official configuration files for Nginx.
 
 Copy the nginx configuration template:
 
-```
+```bash
 $ 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.
+
+```bash
+$ 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.
 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
 
-```
+```bash
 $ 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:
 
+```bash
+$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
 ```
-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;
+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;
-}
+```bash
+$ 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;
+```bash
+$ 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;
-  }
+```bash
+$ # 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 /var/www/peertube/peertube-latest/client/dist/$1;
-  }
+```bash
+$ sudo pkg install dehydrated
+```
 
-  location ~ ^/static/(thumbnails|avatars)/(.*)$ {
-    add_header Cache-Control "public, max-age=31536000, immutable";
+### :alembic: TCP/IP Tuning
 
-    alias /var/www/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;
+```bash
+$ 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;
-    }
+### :bricks: 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;
-    }
+```bash
+$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+```
 
-    alias /var/www/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;
-  }
-}
+```bash
+$ sudo vim /etc/systemd/system/peertube.service
 ```
 
 
-Activate the configuration file:
+Tell systemd to reload its config:
 
+```bash
+$ sudo systemctl daemon-reload
 ```
-$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
-$ sudo systemctl reload nginx
-```
-
-### Systemd
 
-Copy the nginx configuration template:
+If you want to start PeerTube on boot:
 
-```
-$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+```bash
+$ sudo systemctl enable peertube
 ```
 
-Update the service file:
+Run:
 
-```
-$ sudo vim /etc/systemd/system/peertube.service
+```bash
+$ sudo systemctl start peertube
+$ sudo journalctl -feu peertube
 ```
 
-It should look like this:
+**FreeBSD**
+On FreeBSD, copy the startup script and update rc.conf:
 
+```bash
+$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
+$ sudo sysrc peertube_enable="YES"
 ```
-[Unit]
-Description=PeerTube daemon
-After=network.target
 
-[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
+Run:
 
-[Install]
-WantedBy=multi-user.target
+```bash
+$ sudo service peertube start
 ```
 
+### :bricks: OpenRC
 
-Tell systemd to reload its config:
+If your OS uses OpenRC, copy the service script:
 
-```
-$ sudo systemctl daemon-reload
+```bash
+$ 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
+```bash
+$ sudo rc-update add peertube default
 ```
 
-### Run
+Run and print last logs:
 
-```
-$ sudo systemctl start peertube
-$ sudo journalctl -feu peertube
+```bash
+$ sudo /etc/init.d/peertube start
+$ tail -f /var/log/peertube/peertube.log
 ```
 
-### Administrator
+### :technologist: 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:
 
-```
+```bash
 $ 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.
+
+### :tada: 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
 
-Make a SQL backup
+### 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.
+
+```bash
+$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
+$ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd
 ```
+
+#### Manually
+
+Make a SQL backup
+
+```bash
 $ 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:
 
-```
+```bash
 $ 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:
 
-```
+```bash
 $ 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 && \
@@ -284,40 +311,72 @@ $ cd /var/www/peertube/versions && \
 
 Install node dependencies:
 
-```
+```bash
 $ 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:
 
-```
+```bash
 $ 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
+$ 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:
 
-```
+```bash
 $ 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:
 
-Restart PeerTube:
+```bash
+$ 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:
+
+```bash
+$ 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"
 ```
 
-### Things went wrong? 
+### Restart PeerTube
 
-Change `peertube-latest` destination to the previous version and restore your SQL backup:
+If you changed your nginx configuration:
 
+```bash
+$ sudo systemctl reload nginx
+```
+
+If you changed your systemd configuration:
+
+```bash
+$ sudo systemctl daemon-reload
+```
+
+Restart PeerTube and check the logs:
+
+```bash
+$ sudo systemctl restart peertube && sudo journalctl -fu peertube
 ```
+
+### Things went wrong?
+
+Change `peertube-latest` destination to the previous version and restore your SQL backup:
+
+```bash
 $ 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 && 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
 ```