Implement 5036: more readable diff on configuration file when upgrading.

[github/Chocobozzz/PeerTube.git] / support / doc / production.md

diff --git a/support/doc/production.md b/support/doc/production.md
index 48ecf1517e0b20973e425cdf5ac42ea43725a248..ea0a983951f8f8afa9c24a111667128b44d18073 100644 (file)
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -260,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
@@ -328,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:
@@ -339,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
@@ -354,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