support/doc/docker.md

   1 # Docker guide
   2
   3 You can quickly get a server running using Docker. You need to have
   4 [docker](https://www.docker.com/community-edition) and
   5 [docker-compose](https://docs.docker.com/compose/install/) installed.
   6
   7 ## Production
   8
   9 ### Install
  10
  11 **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
  12
  13 PeerTube needs a PostgreSQL and a Redis instance to work correctly. If you want
  14 to quickly set up a full environment, either for trying the service or in
  15 production, you can use a `docker-compose` setup.
  16
  17 ```shell
  18 $ cd /your/peertube/directory
  19 $ mkdir ./docker-volume && mkdir ./docker-volume/traefik
  20 $ curl "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml" > ./docker-volume/traefik/traefik.toml
  21 $ touch ./docker-volume/traefik/acme.json && chmod 600 ./docker-volume/traefik/acme.json
  22 $ 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
  23 ```
  24
  25 Update the reverse proxy configuration:
  26
  27 ```shell
  28 $ vim ./docker-volume/traefik/traefik.toml
  29 ```
  30
  31 Tweak the `docker-compose.yml` file there according to your needs:
  32
  33 ```shell
  34 $ vim ./docker-compose.yml
  35 ```
  36
  37 Then tweak the `.env` file to change the enviromnent variables:
  38
  39 ```shell
  40 $ vim ./.env
  41 ```
  42
  43 Other environment variables are used in
  44 `support/docker/production/config/custom-environment-variables.yaml` and can be
  45 intuited from usage.
  46
  47 You can use the regular `up` command to set it up:
  48
  49 ```shell
  50 $ docker-compose up
  51 ```
  52
  53 **Important**: note that you'll get the initial `root` user password from the
  54 program output, so check out your logs to find them.
  55
  56 ### What now?
  57
  58 See the production guide ["What now" section](/support/doc/production.md#what-now).
  59
  60 ### Upgrade
  61
  62 Pull the latest images and rerun PeerTube:
  63
  64 ```shell
  65 $ cd /your/peertube/directory
  66 $ docker-compose down
  67 $ docker-compose pull
  68 $ docker-compose up -d
  69 ```
  70
  71
  72 ## Build your own Docker image
  73
  74 ```shell
  75 $ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
  76 $ cd /tmp/peertube
  77 $ docker build . -f ./support/docker/production/Dockerfile.stretch
  78 ```
  79
  80 ## Development
  81
  82 We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop)
  83 for more information on how you can hack PeerTube!