X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=8310e7fda880b042bc7d669c9c6b41a875224108;hb=7279b455811f4806dcb74a08d17b837bc22533c1;hp=ee8bf26474ff664e4359dbb7ef18331251bfa572;hpb=e5203ffa1260ee03f0f84ef6b65d57ccad5ee695;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/support/doc/production.md b/support/doc/production.md
index ee8bf2647..8310e7fda 100644
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -1,17 +1,22 @@
 # Production guide
 
+  * [Installation](#installation)
+  * [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. 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
 
-Create a `peertube` user with `/home/peertube` home:
+Create a `peertube` user with `/var/www/peertube` home:
 
 ```
-$ sudo useradd -m -d /home/peertube -s /bin/bash -p peertube peertube
+$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
 ```
 
 Set its password:
@@ -19,6 +24,14 @@ 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:
@@ -34,19 +47,22 @@ 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"
 ```
+
 Open the peertube directory, create a few required directories
 ```
-    cd /home/peertube && sudo -u peertube mkdir config storage versions && cd versions
+$ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions
 ```
+
 Download the latest version of the Peertube client, unzip it and remove the zip
 ```
-    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 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
 ```
-Install Peertube
+
+Install Peertube:
 ```
-    cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest && \
-    cd ./peertube-latest && sudo -u peertube yarn install --production --pure-lockfile
+$ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
+$ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
 ```
 
 ### PeerTube configuration
@@ -54,18 +70,22 @@ Install Peertube
 Copy 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.
 
+**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.
+
 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 modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
@@ -75,214 +95,210 @@ It should correspond to the paths of your storage directories (set in the config
 $ 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).
+Activate the configuration file:
+
+```
+$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
+```
 
-An example of the nginx configuration could be:
+To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
 
 ```
-server {
-  listen 80;
-  listen [::]:80;
-  server_name peertube.example.com;
+$ 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
+```
 
-  access_log /var/log/nginx/peertube.example.com.access.log;
-  error_log /var/log/nginx/peertube.example.com.error.log;
+Remember your certificate will expire in 90 days, and thus needs renewal.
 
-  rewrite ^ https://$server_name$request_uri? permanent;
-}
+Now you have the certificates you can reload nginx:
 
-server {
-  listen 443 ssl http2;
-  listen [::]:443 ssl http2;
-  server_name peertube.example.com;
+```
+$ sudo systemctl 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;
+**FreeBSD**
+On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
 
-  access_log /var/log/nginx/peertube.example.com.access.log;
-  error_log /var/log/nginx/peertube.example.com.error.log;
+```
+$ sudo pkg install dehydrated
+```
 
-  location ^~ '/.well-known/acme-challenge' {
-    default_type "text/plain";
-    root /var/www/certbot;
-  }
+### systemd
 
-  location ~ ^/client/(.*\.(js|css|woff2|otf|ttf|woff|eot))$ {
-    add_header Cache-Control "public, max-age=31536000, immutable";
+If your OS uses systemd, copy the configuration template:
 
-    alias /home/peertube/peertube-latest/client/dist/$1;
-  }
+```
+$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+```
 
-  location ~ ^/static/(thumbnails|avatars)/(.*)$ {
-    add_header Cache-Control "public, max-age=31536000, immutable";
+Update the service file:
 
-    alias /home/peertube/storage/$1/$2;
-  }
+```
+$ sudo vim /etc/systemd/system/peertube.service
+```
 
-  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 8G;
-    proxy_connect_timeout       600;
-    proxy_send_timeout          600;
-    proxy_read_timeout          600;
-    send_timeout                600;
-  }
+Tell systemd to reload its config:
 
-  # 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;
-    }
+```
+$ sudo systemctl daemon-reload
+```
 
-    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 you want to start PeerTube on boot:
 
-      # Don't spam access log file with byte range requests
-      access_log off;
-    }
+```
+$ sudo systemctl enable peertube
+```
 
-    alias /home/peertube/storage/videos;
-  }
+Run:
 
-  # 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 systemctl start peertube
+$ sudo journalctl -feu peertube
 ```
 
+### FreeBSD
 
-Activate the configuration file:
+If you're using FreeBSD, copy the startup script and update rc.conf:
 
 ```
-$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
-$ sudo systemctl reload nginx
+$ 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
 ```
 
-### Systemd
+Run:
 
-Copy the nginx configuration template:
+```
+$ sudo service peertube start
+```
+
+### Administrator
+
+The administrator password is automatically generated and can be found in the
+logs. You can set another password with:
 
 ```
-$ sudo cp /home/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
+$ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
 ```
 
-Update the service file:
+### 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.
 
 ```
-$ sudo vim /etc/systemd/system/peertube.service
+$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
 ```
 
-It should look like this:
+#### 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 pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH"
 ```
-[Unit]
-Description=PeerTube daemon
-After=network.target
 
-[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
+Fetch the latest tagged version of Peertube:
 
-[Install]
-WantedBy=multi-user.target
+```
+$ 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:
 
-Tell systemd to reload its config:
+```
+$ 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
+```
+
+Install node dependencies:
 
 ```
-$ sudo systemctl daemon-reload
+$ cd /var/www/peertube/versions/peertube-${VERSION} && \
+    sudo -H -u peertube yarn install --production --pure-lockfile
 ```
 
-If you want to start PeerTube on boot:
+Copy new configuration defaults values and update your configuration file:
 
 ```
-$ sudo systemctl enable peertube
+$ 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
 ```
 
-### Run
+Change the link to point to the latest version:
 
 ```
-$ sudo systemctl start peertube
-$ sudo journalctl -feu peertube
+$ cd /var/www/peertube && \
+    sudo unlink ./peertube-latest && \
+    sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
 ```
 
-### Administrator
+### nginx
 
-The administrator password is automatically generated and can be found in the
-logs. You can set another password with:
+Check changes in nginx configuration:
 
 ```
-$ cd /home/peertube/peertube-latest && NODE_CONFIG_DIR=/home/peertube/config NODE_ENV=production npm run reset-password -- -u root
+$ cd /var/www/peertube/versions
+$ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
 ```
 
-## Upgrade
+### systemd
 
-Make a SQL backup:
+Check changes in systemd configuration:
 
 ```
-$ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
-    cd /home/peertube && sudo -u peertube mkdir -p backup && \
-    sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH"
+$ 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"
 ```
 
-Update your configuration file. **If some keys are missing, your upgraded PeerTube won't start!**
+### Restart PeerTube
+
+If you changed your nginx configuration:
 
 ```
-$ diff <(curl -s https://raw.githubusercontent.com/Chocobozzz/PeerTube/develop/config/production.yaml.example) /home/peertube/config/production.yaml
+$ sudo systemctl reload nginx
 ```
 
-Upgrade PeerTube:
+If you changed your systemd configuration:
 
 ```
-$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && \
-    cd /home/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 systemctl restart peertube
+$ sudo systemctl daemon-reload
 ```
 
-Things went wrong? Change `peertube-latest` destination to the previous version and restore your SQL backup:
+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 /home/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 -c -d peertube_prod "$SQL_BACKUP_PATH"
+    pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH"
     sudo systemctl restart peertube
 ```