X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fdocker.md;h=cf3a0db0b6b555304645c2894b05b56efaf96326;hb=08d70fe60672976416b92fbb927898125166bfe7;hp=05050801e65c9a898ca10896afd42a503d20fc18;hpb=7f456189b71b1b0dda962e583d2119cfd4aa1af9;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/docker.md b/support/doc/docker.md index 05050801e..cf3a0db0b 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -1,26 +1,127 @@ # Docker guide -## Test/Development +This guide requires [docker](https://www.docker.com/community-edition) and +[docker-compose](https://docs.docker.com/compose/install/). -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. +## Production + +### Install + +**PeerTube does not support webserver host change**. Keep in mind your domain +name is definitive after your first PeerTube start. + +#### 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 +``` + +#### Get the latest Compose file + +```shell +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/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 +``` + +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 +``` + +#### 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](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 + +To test locally your Docker setup, you must add your domain (``) in `/etc/hosts`: +``` +127.0.0.1 localhost mydomain.tld +``` -For this example configuration, you should also run a reverse proxy. The example -Docker Compose file provides example labels for the Traefik load balancer, -though any HTTP reverse proxy is compatible. +#### You can use the regular `up` command to set it up + +```shell +docker-compose up +``` -Example for running a peertube server locally: +### 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 -wget https://framagit.org/chocobozzz/PeerTube/raw/develop/support/docker/production/docker-compose.yml -sudo \ - PEERTUBE_HOSTNAME=peertube.lvh.me \ - PEERTUBE_ADMIN_EMAIL=test@example.com \ - PEERTUBE_TRANSCODING_ENABLED=true \ - docker-compose up app +$ 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 ``` -(Get the initial root user password from the program output.) +### Obtaining Your Automatically Generated DKIM DNS TXT Record -## Production +[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 +``` + +### 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/develop/support/docker/production/config/production.yaml). + +Pull the latest images and rerun PeerTube: + +```shell +$ cd /your/peertube/directory +$ docker-compose pull +$ docker-compose up -d +``` + +## Build your own Docker image + +```shell +$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube +$ cd /tmp/peertube +$ docker build . -f ./support/docker/production/Dockerfile.buster +``` + +## Development -PR welcome! +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!