X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fdocker.md;h=e3f9b5477cf154d47f01f934472f2618a119101e;hb=393f9d396cdbe39e50856859a44f3996a2bc76f9;hp=fc89e4c4cf1f1cf8a6bafbad2970862b305309d0;hpb=23cbb0f3189b4b7d712d304d9a19d8b565e1d166;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/docker.md b/support/doc/docker.md index fc89e4c4c..e3f9b5477 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -1,48 +1,21 @@ # Docker guide -You can quickly get a server running using Docker. You need to have -[docker](https://www.docker.com/community-edition) and -[docker-compose](https://docs.docker.com/compose/install/) installed. +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. -**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start. +#### Go to your workdir -PeerTube needs a PostgreSQL and a Redis instance to work correctly. If you want -to quickly set up a full environment, either for trying the service or in -production, you can use a `docker-compose` setup. +_note_: the guide that follows assumes an empty workdir, but you can also clone the repository, use the master branch and `cd support/docker/production`. -#### Go to your peertube workdir ```shell cd /your/peertube/directory ``` -#### Create the reverse proxy configuration directory - -```shell -mkdir -p ./docker-volume/traefik -``` - -#### Get the latest reverse proxy configuration - -```shell -curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml > ./docker-volume/traefik/traefik.toml -``` - -View the source of the file you're about to download: [traefik.toml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/config/traefik.toml) - -#### Create Let's Encrypt ACME certificates as JSON file - -```shell -touch ./docker-volume/traefik/acme.json -``` -Needs to have file mode 600: -```shell -chmod 600 ./docker-volume/traefik/acme.json -``` - #### Get the latest Compose file ```shell @@ -51,7 +24,6 @@ curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker 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 @@ -60,99 +32,132 @@ curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env) -#### Update the reverse proxy configuration - -```shell -vim ./docker-volume/traefik/traefik.toml -``` - -~~You must replace `` and `` to enable Let's Encrypt SSL Certificates creation.~~ Now included in `.env` file with `TRAEFIK_ACME_EMAIL` and `TRAEFIK_ACME_DOMAINS` variables used through traefik service command value of `docker-compose.yml` file. - -More at: https://docs.traefik.io/v1.7 - #### Tweak the `docker-compose.yml` file there according to your needs ```shell -vim ./docker-compose.yml +sudo nano docker-compose.yml ``` -#### Then tweak the `.env` file to change the environment variables +#### Then tweak the `.env` file to change the environment variables settings ```shell -vim ./.env +sudo nano .env ``` + 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/master/support/docker/production/config/custom-environment-variables.yaml) and can be intuited from usage. -#### Testing local Docker setup +#### Webserver -To test locally your Docker setup, you must add your domain (``) in `/etc/hosts`: +*The docker compose file includes a configured web server. You can skip this part and comment the appropriate section in the docker compose if you use another webserver/proxy.* + +Install the template that the nginx container will use. +The container will generate the configuration by replacing `${WEBSERVER_HOST}` and `${PEERTUBE_HOST}` using your docker compose env file. + +```shell +mkdir -p docker-volume/nginx +curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/nginx/peertube > docker-volume/nginx/peertube ``` -127.0.0.1 localhost mydomain.tld + +You need to manually generate the first SSL/TLS certificate using Let's Encrypt: + +```shell +mkdir -p docker-volume/certbot +docker run -it --rm --name certbot -p 80:80 -v "$(pwd)/docker-volume/certbot/conf:/etc/letsencrypt" certbot/certbot certonly --standalone ``` -#### You can use the regular `up` command to set it up +A dedicated container in the docker-compose will automatically renew this certificate and reload nginx. + + +#### 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 -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. -```BASH -user@s:~/peertube|master⚡ ⇒ docker-compose logs peertube | grep -A1 root + +#### Obtaining your automatically-generated admin credentials + +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 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/). + Run `cat ./docker-volume/opendkim/keys/*/*.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain : -```BASH -user@s:~/peertube|master⚡ ⇒ cat ./docker-volume/opendkim/keys/*/*.txt + +```bash +$ cat ./docker-volume/opendkim/keys/*/*.txt peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; " "p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Dx7wLGPFVaxVQ4TGym/eF89aQ8oMxS9v5BCc26Hij91t2Ci8Fl12DHNVqZoIPGm+9tTIoDVDFEFrlPhMOZl8i4jU9pcFjjaIISaV2+qTa8uV1j3MyByogG8pu4o5Ill7zaySYFsYB++cHJ9pjbFSC42dddCYMfuVgrBsLNrvEi3dLDMjJF5l92Uu8YeswFe26PuHX3Avr261n" "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#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#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 and rerun PeerTube: +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): + +```shell +$ docker-compose down -v +``` + +Rerun PeerTube: + +```shell $ 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/master/.github/CONTRIBUTING.md#develop) -for more information on how you can hack PeerTube! +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!