Fill documentation with required secret conf

diff --git a/config/default.yaml b/config/default.yaml
index 890d7acf96c3498fe1924dff1c95952d2b7d0e04..f94ec620977739f048214b980c94b0a18c30702c 100644 (file)
--- a/config/default.yaml
+++ b/config/default.yaml
@@ -12,6 +12,7 @@ webserver:
 
 # Secrets you need to generate the first time you run PeerTube
 secrets:
+  # Generate one using `openssl rand -hex 32`
   peertube: ''
 
 rates_limit:

diff --git a/config/production.yaml.example b/config/production.yaml.example
index 399ac94f2b13ac63d7a8b6b997f1e3db708483b2..e37ff9b8a7558b5b64394db7058a9c8c032cfb7c 100644 (file)
--- a/config/production.yaml.example
+++ b/config/production.yaml.example
@@ -10,6 +10,7 @@ webserver:
 
 # Secrets you need to generate the first time you run PeerTube
 secret:
+  # Generate one using `openssl rand -hex 32`
   peertube: ''
 
 rates_limit:

diff --git a/support/doc/docker.md b/support/doc/docker.md
index 97eecc3adfc0620717080ace6f2346d6b2fa019b..267863a4d38c34b3ab058be16f2fad64df155b0e 100644 (file)
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -49,6 +49,7 @@ In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/mas
 - `<MY POSTGRES PASSWORD>`
 - `<MY DOMAIN>` without 'https://'
 - `<MY EMAIL ADDRESS>`
+- `<MY PEERTUBE SECRET>`
 
 Other environment variables are used in
 [/support/docker/production/config/custom-environment-variables.yaml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/config/custom-environment-variables.yaml) and can be

diff --git a/support/doc/production.md b/support/doc/production.md
index 64ddd9e489aaf6f1b32c3222640aa144be9699cc..b400ac4510660d722f8cfa166b2c68e8121c87a3 100644 (file)
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -115,8 +115,14 @@ $ 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
-and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
+Then edit the `config/production.yaml` file according to your webserver and database configuration. In particular:
+ * `webserver`: Reverse proxy public information
+ * `secrets`: Secret strings you must generate manually (PeerTube version >= 5.0)
+ * `database`: PostgreSQL settings
+ * `redis`: Redis settings
+ * `smtp`: If you want to use emails
+ * `admin.email`: To correctly fill `root` user email
+
 Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
 
 **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.

diff --git a/support/docker/production/.env b/support/docker/production/.env
index 4e7b21ab676867f204ad133d0d4c8f5a55bb0033..b4e356a58f35cd5d88e8d47cb73e2dcc94fe8297 100644 (file)
--- a/support/docker/production/.env
+++ b/support/docker/production/.env
@@ -22,6 +22,9 @@ PEERTUBE_WEBSERVER_HOSTNAME=<MY DOMAIN>
 # pass them as a comma separated array:
 PEERTUBE_TRUST_PROXY=["127.0.0.1", "loopback", "172.18.0.0/16"]
 
+# Generate one using `openssl rand -hex 32`
+PEERTUBE_SECRET=<MY PEERTUBE SECRET>
+
 # E-mail configuration
 # If you use a Custom SMTP server
 #PEERTUBE_SMTP_USERNAME=

diff --git a/support/docker/production/config/custom-environment-variables.yaml b/support/docker/production/config/custom-environment-variables.yaml
index 9c84428b78621e5b1bee7ad7c9bac6504f248d82..1d889fe7df5a6b491408d080a9107e167e465494 100644 (file)
--- a/support/docker/production/config/custom-environment-variables.yaml
+++ b/support/docker/production/config/custom-environment-variables.yaml
@@ -7,6 +7,9 @@ webserver:
     __name: "PEERTUBE_WEBSERVER_HTTPS"
     __format: "json"
 
+secrets:
+  peertube: "PEERTUBE_SECRET"
+
 trust_proxy:
   __name: "PEERTUBE_TRUST_PROXY"
   __format: "json"