aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2022-10-10 11:19:45 +0200
committerChocobozzz <me@florianbigard.com>2022-10-10 11:19:45 +0200
commit1ea868a9456439108fbd87255537093ed8bd456f (patch)
tree7b7fc86ef48695d7a2f086997c97baf4462c2347 /support
parenta3e5f804ad821f6979e8735b0569b1209986fedc (diff)
downloadPeerTube-1ea868a9456439108fbd87255537093ed8bd456f.tar.gz
PeerTube-1ea868a9456439108fbd87255537093ed8bd456f.tar.zst
PeerTube-1ea868a9456439108fbd87255537093ed8bd456f.zip
Fill documentation with required secret conf
Diffstat (limited to 'support')
-rw-r--r--support/doc/docker.md1
-rw-r--r--support/doc/production.md10
-rw-r--r--support/docker/production/.env3
-rw-r--r--support/docker/production/config/custom-environment-variables.yaml3
4 files changed, 15 insertions, 2 deletions
diff --git a/support/doc/docker.md b/support/doc/docker.md
index 97eecc3ad..267863a4d 100644
--- 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
49- `<MY POSTGRES PASSWORD>` 49- `<MY POSTGRES PASSWORD>`
50- `<MY DOMAIN>` without 'https://' 50- `<MY DOMAIN>` without 'https://'
51- `<MY EMAIL ADDRESS>` 51- `<MY EMAIL ADDRESS>`
52- `<MY PEERTUBE SECRET>`
52 53
53Other environment variables are used in 54Other environment variables are used in
54[/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 55[/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 64ddd9e48..b400ac451 100644
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -115,8 +115,14 @@ $ cd /var/www/peertube
115$ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml 115$ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
116``` 116```
117 117
118Then edit the `config/production.yaml` file according to your webserver 118Then edit the `config/production.yaml` file according to your webserver and database configuration. In particular:
119and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular). 119 * `webserver`: Reverse proxy public information
120 * `secrets`: Secret strings you must generate manually (PeerTube version >= 5.0)
121 * `database`: PostgreSQL settings
122 * `redis`: Redis settings
123 * `smtp`: If you want to use emails
124 * `admin.email`: To correctly fill `root` user email
125
120Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`. 126Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
121 127
122**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. 128**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 4e7b21ab6..b4e356a58 100644
--- a/support/docker/production/.env
+++ b/support/docker/production/.env
@@ -22,6 +22,9 @@ PEERTUBE_WEBSERVER_HOSTNAME=<MY DOMAIN>
22# pass them as a comma separated array: 22# pass them as a comma separated array:
23PEERTUBE_TRUST_PROXY=["127.0.0.1", "loopback", "172.18.0.0/16"] 23PEERTUBE_TRUST_PROXY=["127.0.0.1", "loopback", "172.18.0.0/16"]
24 24
25# Generate one using `openssl rand -hex 32`
26PEERTUBE_SECRET=<MY PEERTUBE SECRET>
27
25# E-mail configuration 28# E-mail configuration
26# If you use a Custom SMTP server 29# If you use a Custom SMTP server
27#PEERTUBE_SMTP_USERNAME= 30#PEERTUBE_SMTP_USERNAME=
diff --git a/support/docker/production/config/custom-environment-variables.yaml b/support/docker/production/config/custom-environment-variables.yaml
index 9c84428b7..1d889fe7d 100644
--- a/support/docker/production/config/custom-environment-variables.yaml
+++ b/support/docker/production/config/custom-environment-variables.yaml
@@ -7,6 +7,9 @@ webserver:
7 __name: "PEERTUBE_WEBSERVER_HTTPS" 7 __name: "PEERTUBE_WEBSERVER_HTTPS"
8 __format: "json" 8 __format: "json"
9 9
10secrets:
11 peertube: "PEERTUBE_SECRET"
12
10trust_proxy: 13trust_proxy:
11 __name: "PEERTUBE_TRUST_PROXY" 14 __name: "PEERTUBE_TRUST_PROXY"
12 __format: "json" 15 __format: "json"