X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=fd29571596efb76b0b99cd3ad464f67ce1fc2638;hb=396f224b5c798ff4a300ca5c937ddee7a9dfee47;hp=ba76a81cfcee9cf2499884ebcb97953ef415aba7;hpb=1007a0185f5e3c1330a78f07d60f8dda9f5ddd15;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/production.md b/support/doc/production.md index ba76a81cf..fd2957159 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -1,15 +1,15 @@ # 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 @@ -24,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: @@ -51,7 +59,13 @@ $ 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 +*If you're using CentOS7, do not forget to activate the devtoolset-7 software collection. +And after that, follow the step as usual. Do not forget to exit the environment after installing Peertube:* +``` +$ sudo scl enable devtoolset-7 bash +``` + +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,8 +82,12 @@ $ 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. + Copy the nginx configuration template: ``` @@ -83,116 +101,40 @@ 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). - -An example of the nginx configuration could be: +Activate the configuration file: ``` -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 - 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; - - 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 8G; - proxy_connect_timeout 600; - proxy_send_timeout 600; - proxy_read_timeout 600; - send_timeout 600; - } +$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube +``` - # 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; - } +To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/): - 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'; +``` +$ 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 +``` - # Don't spam access log file with byte range requests - access_log off; - } +Remember your certificate will expire in 90 days, and thus needs renewal. - alias /var/www/peertube/storage/videos; - } +Now you have the certificates you can reload nginx: - # 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 reload nginx ``` - -Activate the configuration file: +**FreeBSD** +On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/) ``` -$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube -$ sudo systemctl reload nginx +$ sudo pkg install dehydrated ``` -### Systemd +### systemd -Copy the nginx 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/ @@ -204,30 +146,6 @@ Update the service file: $ sudo vim /etc/systemd/system/peertube.service ``` -It should look like this: - -``` -[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 - -[Install] -WantedBy=multi-user.target -``` - Tell systemd to reload its config: @@ -241,13 +159,29 @@ If you want to start PeerTube on boot: $ 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 @@ -257,20 +191,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 ``` +### 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 -#### Auto -Via the bash Script : +### 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. ``` -$ su - peertube -$ cd scripts && ./upgrade.sh -$ exit -$ systemctl restart peertube -$ systemctl status peertube +$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh ``` -#### Manuel +#### Manually + Make a SQL backup ``` @@ -298,37 +241,69 @@ 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: ``` $ 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: ``` $ 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 + +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: -Restart PeerTube: ``` -$ sudo systemctl restart peertube +$ 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