X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=support%2Fdoc%2Fdocker.md;h=d7059d285b5aee0235fc39cd81b5d2e8e588752e;hb=7024e9120b381b5b3201212f5a18f5cdc14e15ff;hp=3d25d06c46a56c0496a02797628f6a87ad387410;hpb=03ae9d887ae46bef62cfd2b46c1d6b0836bea246;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/docker.md b/support/doc/docker.md index 3d25d06c4..d7059d285 100644 --- a/support/doc/docker.md +++ b/support/doc/docker.md @@ -6,68 +6,88 @@ You can quickly get a server running using Docker. You need to have ## Production -### Build your own Docker image +### Install -```bash -$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube -$ cd /tmp/peertube -$ docker build . -f ./support/docker/production/Dockerfile.stretch -``` - -### Run a preconfigured setup with all dependencies +**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start. 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. -```bash -$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube -$ cd /tmp/peertube/support/docker/production +```shell +$ cd /your/peertube/directory +$ mkdir ./docker-volume && mkdir ./docker-volume/traefik +$ curl "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml" > ./docker-volume/traefik/traefik.toml +$ touch ./docker-volume/traefik/acme.json && chmod 600 ./docker-volume/traefik/acme.json +$ curl -s "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml" -o docker-compose.yml "https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env" -o .env +``` +View the source of the files you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/docker-compose.yml) and the [traefik.toml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/config/traefik.toml) and the [.env] +(https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env) + +Update the reverse proxy configuration: + +```shell +$ vim ./docker-volume/traefik/traefik.toml +``` + +Tweak the `docker-compose.yml` file there according to your needs: + +```shell +$ vim ./docker-compose.yml ``` -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: - -```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 +Then tweak the `.env` file to change the environment variables: + +```shell +$ vim ./.env ``` +If you did not download the .env file above, here you can look at the variables that can be set: +https://github.com/Chocobozzz/PeerTube/blob/develop/support/docker/production/.env Other environment variables are used in `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. - -When starting the containers for the first time, you will get permissions errors for the data volume, like this one: +You can use the regular `up` command to set it up: +```shell +$ docker-compose up ``` -Error: EACCES: permission denied, mkdir '/data/logs' +### 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 + +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 ``` -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`: +### What now? +See the production guide ["What now" section](/support/doc/production.md#what-now). + +### Upgrade + +**Important:** Before upgrading, check you have all the `storage` fields in your [production.yaml file](/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 ``` -chown -R 991:991 data/ -``` -**Important**: note that you'll get the initial `root` user password from the -program output, so check out your logs to find them. +## 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 -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!