X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fdocker.md;h=036ea19d493d37dfae23e8a63c63737be42dea4b;hb=424aeb12bd16f5d6763dfa2860d113cc93876405;hp=3d25d06c46a56c0496a02797628f6a87ad387410;hpb=03ae9d887ae46bef62cfd2b46c1d6b0836bea246;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/docker.md b/support/doc/docker.md index 3d25d06c4..036ea19d4 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -1,73 +1,155 @@ # 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 -### Build your own Docker image +**PeerTube does not support webserver host change**. Keep in mind your domain +name is definitive after your first PeerTube start. -```bash -$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube -$ cd /tmp/peertube -$ docker build . -f ./support/docker/production/Dockerfile.stretch +#### Go to your workdir + +_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`. + +```shell +cd /your/peertube/directory ``` -### Run a preconfigured setup with all dependencies +#### Get the latest Compose file -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. +```shell +curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml +``` -```bash -$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube -$ cd /tmp/peertube/support/docker/production +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/master/support/docker/production/.env > .env ``` -Then tweak the `docker-compose.yml` file there according to your needs. Then -you can use the regular `up` command to set it up, with possible overrides of -the environment variables: +View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env) -```bash -$ PEERTUBE_HOSTNAME=peertube.lvh.me \ - PEERTUBE_ADMIN_EMAIL=test@example.com \ - PEERTUBE_TRANSCODING_ENABLED=true \ - PEERTUBE_SIGNUP_ENABLED=true \ - PEERTUBE_SMTP_HOST=mail.lvh.me \ - PEERTUBE_SMTP_PORT=1025 \ - PEERTUBE_SMTP_FROM=noreply@peertube.lvh.me \ - docker-compose up +#### Tweak the `docker-compose.yml` file there according to your needs + +```shell +$EDITOR ./docker-compose.yml ``` +#### Then tweak the `.env` file to change the environment variables settings + +```shell +$EDITOR ./.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` 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. -For this example configuration, a reverse proxy is quite recommended. The -example Docker Compose file provides example labels for a Traefik load -balancer, although any HTTP reverse proxy will work fine. See the example -Nginx configuration `support/nginx/peertube` file to get an idea of -recommendations and requirements to run PeerTube the most efficiently. +#### Webserver + +*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 +``` + +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 +``` + +A dedicated container in the docker-compose will automatically renew this certificate and reload nginx. + + +#### Test your setup + +Run your containers: -When starting the containers for the first time, you will get permissions errors for the data volume, like this one: +```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 +$ 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 ``` -Error: EACCES: permission denied, mkdir '/data/logs' + +#### 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 +$ 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 ``` -The peertube user inside the container has a UID and GID of 991 so you have to change the folder's owner, in the case you're using `./data`: +#### Administrator password + +See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator) + +#### What now? + +See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now). +## Upgrade + +**Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/config/production.yaml). + +Pull the latest images: + +```shell +$ cd /your/peertube/directory +$ docker-compose pull ``` -chown -R 991:991 data/ + +Stop, delete the containers and internal volumes (to invalidate static client files shared by `peertube` and `webserver` containers): + +```shell +$ docker-compose down -v ``` -**Important**: note that you'll get the initial `root` user password from the -program output, so check out your logs to find them. +Rerun PeerTube: + +```shell +$ docker-compose up -d +``` + +## Build + +### Production + +```shell +$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube +$ cd /tmp/peertube +$ docker build . -f ./support/docker/production/Dockerfile.bullseye +``` -## Development +### Development -The Docker image that's preconfigured in `support/docker/dev` contains all the -services embedded in one image, so as to work correctly on -[Janitor](https://janitor.technology). It is much not advised to use it in -production. +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!