X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=support%2Fdoc%2Fdocker.md;h=036ea19d493d37dfae23e8a63c63737be42dea4b;hb=3c33d71474786ce39049b000fc6bc20404d19002;hp=e55aee9fc9290f156891fabde6971d53532b12c2;hpb=b8f3e6b00b3300f4ebf37bf77711739964c9e5d6;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/docker.md b/support/doc/docker.md index e55aee9fc..036ea19d4 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -1,16 +1,16 @@ # Docker guide This guide requires [docker](https://www.docker.com/community-edition) and -[docker-compose](https://docs.docker.com/compose/install/) installed. +[docker-compose](https://docs.docker.com/compose/install/). -## Production +## Install -### Install - -**PeerTube does not support webserver host change**. Keep in mind your domain +**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start. -#### Go to your peertube workdir +#### 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 @@ -38,7 +38,7 @@ View the source of the file you're about to download: [.env](https://github.com/ $EDITOR ./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 $EDITOR ./.env @@ -54,72 +54,102 @@ 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 + +*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.* -To test locally your Docker setup, you must add your domain (``) in `/etc/hosts`: +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 + +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. ```bash -user@s:~/peertube|master⚡ ⇒ docker-compose logs peertube | grep -A1 root +$ 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 : +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 +$ 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?id=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=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). +**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 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!