X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fdocker.md;h=6fc443c8e8c81679db5a53e33614ecdb5cb3c6d5;hb=85ae729151173807114623c1e02c8c763e07cc01;hp=d09688feb82b47f0fe21c23061fca21ba9cf043c;hpb=b826b3398362affce6a1a5a589aa79938fef3021;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/docker.md b/support/doc/docker.md index d09688feb..6fc443c8e 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -3,9 +3,7 @@ This guide requires [docker](https://www.docker.com/community-edition) and [docker-compose](https://docs.docker.com/compose/install/). -## Production - -### Install +## Install **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start. @@ -21,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: - `` - `` - `` without 'https://' - `` +- `` 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 @@ -65,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: @@ -80,15 +79,22 @@ 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 docker-compose up ``` -### Obtaining your automatically-generated admin credentials +#### 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 @@ -97,7 +103,7 @@ peertube_1 | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop ``` -### Obtaining Your Automatically Generated DKIM DNS TXT Record +#### Obtaining Your Automatically Generated DKIM DNS TXT Record [DKIM](https://en.wikipedia.org/wiki/DomainKeys_Identified_Mail) signature sending and RSA keys generation are enabled by the default Postfix image `mwader/postfix-relay` with [OpenDKIM](http://www.opendkim.org/). @@ -111,23 +117,24 @@ peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; " "j5joTnYwat4387VEUyGUnZ0aZxCERi+ndXv2/wMJ0tizq+a9+EgqIb+7lkUc2XciQPNuTujM25GhrQBEKznvHyPA6fHsFheymOuB763QpkmnQQLCxyLygAY9mE/5RY+5Q6J9oDOQIDAQAB" ) ; ----- DKIM key peertube for mydomain.tld ``` -### Administrator password +#### 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?id=technologist-administrator) -### What now? +#### 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?id=tada-what-now). -### Upgrade +## 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: ```shell $ cd /your/peertube/directory $ docker-compose pull +``` Stop, delete the containers and internal volumes (to invalidate static client files shared by `peertube` and `webserver` containers): @@ -141,14 +148,16 @@ Rerun PeerTube: $ docker-compose up -d ``` -## Build your own Docker image +## Build + +### Production ```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 +### Development We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop) for more information on how you can hack PeerTube!