Add redis version note

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

diff --git a/support/doc/docker.md b/support/doc/docker.md
index d83ee3997e7edf99a8c545a6834f9d72c39f8187..e3f9b5477cf154d47f01f934472f2618a119101e 100644 (file)
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -19,39 +19,40 @@ cd /your/peertube/directory
 #### Get the latest Compose file
 
 ```shell
-curl https://raw.githubusercontent.com/chocobozzz/PeerTube/develop/support/docker/production/docker-compose.yml > docker-compose.yml
+curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml
 ```
 
-View the source of the file you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/docker-compose.yml)
+View the source of the file you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/docker-compose.yml)
 
 #### Get the latest env_file
 
 ```shell
-curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/develop/support/docker/production/.env > .env
+curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env > .env
 ```
 
-View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env)
+View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env)
 
 #### Tweak the `docker-compose.yml` file there according to your needs
 
 ```shell
-$EDITOR ./docker-compose.yml
+sudo nano docker-compose.yml
 ```
 
 #### Then tweak the `.env` file to change the environment variables settings
 
 ```shell
-$EDITOR ./.env
+sudo nano .env
 ```
 
-In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env), you must replace:
+In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env), you must replace:
 - `<MY POSTGRES USERNAME>`
 - `<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/develop/support/docker/production/config/custom-environment-variables.yaml) and can be
+[/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
 intuited from usage.
 
 #### Webserver
@@ -63,7 +64,7 @@ The container will generate the configuration by replacing `${WEBSERVER_HOST}` a
 
 ```shell
 mkdir -p docker-volume/nginx
-curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/develop/support/nginx/peertube > docker-volume/nginx/peertube
+curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/nginx/peertube > docker-volume/nginx/peertube
 ```
 
 You need to manually generate the first SSL/TLS certificate using Let's Encrypt:
@@ -78,6 +79,8 @@ A dedicated container in the docker-compose will automatically renew this certif
 
 #### Test your setup
 
+_note_: Newer versions of compose are called with `docker compose` instead of `docker-compose`, so remove the dash in all steps that use this command if you are getting errors.
+
 Run your containers:
 
 ```shell
@@ -86,7 +89,12 @@ docker-compose up
 
 #### Obtaining your automatically-generated admin credentials
 
-Now that you've installed your PeerTube instance you'll want to grep your peertube container's logs for the `root` password. You're going to want to run `docker-compose logs peertube | grep -A1 root` to search the log output for your new PeerTube's instance admin credentials which will look something like this.
+You can change the automatically created password for user root by running this command from peertube's root directory:
+```shell
+docker-compose exec -u peertube peertube npm run reset-password -- -u root
+```
+
+You can also grep your peertube container's logs for the default `root` password. You're going to want to run `docker-compose logs peertube | grep -A1 root` to search the log output for your new PeerTube's instance admin credentials which will look something like this.
 
 ```bash
 $ docker-compose logs peertube | grep -A1 root
@@ -111,15 +119,15 @@ peertube._domainkey.mydomain.tld. IN      TXT     ( "v=DKIM1; h=sha256; k=rsa; "
 
 #### Administrator password
 
-See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator)
+See the production guide ["Administrator" section](https://docs.joinpeertube.org/install/any-os#administrator)
 
 #### What now?
 
-See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now).
+See the production guide ["What now" section](https://docs.joinpeertube.org/install/any-os#what-now).
 
 ## Upgrade
 
-**Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/config/production.yaml).
+**Check the changelog (in particular the *IMPORTANT NOTES* section):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
 
 Pull the latest images:
 
@@ -147,7 +155,7 @@ $ docker-compose up -d
 ```shell
 $ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
 $ cd /tmp/peertube
-$ docker build . -f ./support/docker/production/Dockerfile.buster
+$ docker build . -f ./support/docker/production/Dockerfile.bullseye
 ```
 
 ### Development