X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fproduction.md;h=81748ae166e86c2756fdb18c4692da4a228fdd13;hb=8f608a4cb22ab232cfab20665050764b38bac9c7;hp=6febaba5d4e79694bc1fa8f332d17fde3264b9c5;hpb=0539dba824bc3b964faaba358d8e7836e006b899;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/support/doc/production.md b/support/doc/production.md
index 6febaba5d..81748ae16 100644
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -6,7 +6,7 @@
 ## Installation
 
 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://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube).
+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
 
@@ -38,7 +38,14 @@ or use `adduser` to create it interactively.
 Create the production database and a peertube user inside PostgreSQL:
 
 ```
+$ cd /var/www/peertube
 $ sudo -u postgres createuser -P peertube
+```
+
+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.
+
+```
 $ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
 ```
 
@@ -58,33 +65,47 @@ $ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/la
 
 Open the peertube directory, create a few required directories
 ```
-$ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions
+$ 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
 ```
+$ 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
+$ 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
 
-Copy example configuration:
+Copy the default configuration file that contains the default configuration provided by PeerTube.
+You **must not** update this file.
 
 ```
-$ cd /var/www/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/default.yaml config/default.yaml
+```
+
+Now copy the production example configuration:
+
+```
+$ 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**. Keep in mind your domain name is definitive after your first PeerTube start.
+**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
 
@@ -96,11 +117,12 @@ Copy the nginx configuration template:
 $ 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. 
+Then set the domain for the webserver configuration file.
+Replace `[peertube-domain]` with the domain for the peertube server.
 
 ```
-$ sudo sed -i 's/peertube.example.com/[peertube-domain]/g' /etc/nginx/sites-available/peertube
+$ 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.
@@ -120,20 +142,25 @@ To generate the certificate for your domain as required to make https work you c
 
 ```
 $ 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 certbot certonly --standalone --post-hook "systemctl restart nginx"
 $ sudo systemctl reload nginx
 ```
 
-Remember your certificate will expire in 90 days, and thus needs renewal.
-
 Now you have the certificates you can reload nginx:
 
 ```
 $ 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:
+
+```
+$ # Replace authenticator = standalone by authenticator = webroot
+$ # Add webroot_path = /var/www/certbot
+$ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
+```
+
 **FreeBSD**
 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
 
@@ -162,7 +189,7 @@ If your OS uses systemd, copy the configuration template:
 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
 ```
 
-Update the service file:
+Check the service file (PeerTube paths and security directives):
 
 ```
 $ sudo vim /etc/systemd/system/peertube.service
@@ -225,8 +252,8 @@ $ tail -f /var/log/peertube/peertube.log
 
 ### 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:
 
 ```
 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
@@ -238,9 +265,8 @@ to your own administrator password, although it must be 6 characters or more.
 ### 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/
+
+ * 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
@@ -249,7 +275,7 @@ Now your instance is up you can:
 
 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
 
-#### Auto (minor versions only)
+#### Auto
 
 The password it asks is PeerTube's database user password.