X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=64ddd9e489aaf6f1b32c3222640aa144be9699cc;hb=d12b40fb96d56786a96c06a621f3d8e0a0d24f4a;hp=e711f09979f273304383004cb0c27eedeb443fb9;hpb=fa66c9a601d69f6d57c956a3513e8bbed7ee9616;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/production.md b/support/doc/production.md index e711f0997..64ddd9e48 100644 --- a/support/doc/production.md +++ b/support/doc/production.md @@ -25,6 +25,12 @@ Set its password: $ sudo passwd peertube ``` +Ensure the peertube root directory is traversable by nginx: + +```bash +$ ls -ld /var/www/peertube # Should be drwxr-xr-x +``` + **On FreeBSD** ```bash @@ -58,26 +64,34 @@ $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod ### :page_facing_up: Prepare PeerTube directory -Fetch the latest tagged version of Peertube +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 + +Open the peertube directory, create a few required directories: + ```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 + +Download the latest version of the Peertube client, unzip it and remove the zip: + ```bash $ cd /var/www/peertube/versions +$ # Releases are also available on https://builds.joinpeertube.org/release $ 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: + ```bash $ cd /var/www/peertube $ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest @@ -146,12 +160,6 @@ $ sudo certbot certonly --standalone --post-hook "systemctl restart nginx" $ sudo systemctl reload nginx ``` -Now you have the certificates you can reload nginx: - -```bash -$ sudo systemctl reload nginx -``` - 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: @@ -252,7 +260,7 @@ $ tail -f /var/log/peertube/peertube.log ### :technologist: Administrator -The administrator password is automatically generated and can be found in the PeerTube +The administrator username is `root` and the password is automatically generated. It can be found in PeerTube logs (path defined in `production.yaml`). You can also set another password with: ```bash @@ -273,7 +281,7 @@ Now your instance is up you can: ### PeerTube instance -**Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md +**Check the changelog (in particular the *IMPORTANT NOTES* section):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md #### Auto @@ -320,7 +328,7 @@ 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 -u /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: @@ -331,13 +339,22 @@ $ cd /var/www/peertube && \ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest ``` +### Configuration + +You can check for configuration changes, and report them in your `config/production.yaml` file: + +```bash +$ cd /var/www/peertube/versions +$ diff -u "$(ls --sort=t | head -2 | tail -1)/config/production.yaml.example" "$(ls --sort=t | head -1)/config/production.yaml.example" +``` + ### nginx Check changes in nginx configuration: ```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" +$ diff -u "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube" ``` ### systemd @@ -346,7 +363,7 @@ 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" +$ diff -u "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service" ``` ### Restart PeerTube