]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - support/doc/docker.md
Resume video on peertube link click in embed
[github/Chocobozzz/PeerTube.git] / support / doc / docker.md
CommitLineData
4df6a1b8
C
1# Docker guide
2
ef48a0d5
BB
3You 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.
4df6a1b8 6
ef48a0d5
BB
7## Production
8
b44a9630 9### Install
4df6a1b8 10
ef48a0d5
BB
11PeerTube needs a PostgreSQL and a Redis instance to work correctly. If you want
12to quickly set up a full environment, either for trying the service or in
13production, you can use a `docker-compose` setup.
4df6a1b8
C
14
15```bash
b44a9630
C
16$ cd /your/peertube/directory
17$ mkdir ./docker-volume && mkdir ./docker-volume/traefik
18$ curl "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/config/traefik.toml" > ./docker-volume/traefik/traefik.toml
19$ touch ./docker-volume/traefik/acme.json && chmod 600 ./docker-volume/traefik/acme.json
20$ curl -s "https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml" > ./docker-compose.yml
21```
22
23Update the reverse proxy configuration:
24
4df6a1b8 25```
b44a9630
C
26$ vim ./docker-volume/traefik/traefik.toml
27```
28
29Tweak the `docker-compose.yml` file there according to your needs:
4df6a1b8 30
b44a9630
C
31```
32$ vim ./docker-compose.yaml
33```
34
35You can use the regular `up` command to set it up, with possible overrides of
ef48a0d5 36the environment variables:
4df6a1b8 37
ef48a0d5 38```bash
b44a9630 39$ PEERTUBE_WEBSERVER_HOSTNAME="domain.tld" docker-compose up
ef48a0d5
BB
40```
41
42Other environment variables are used in
43`support/docker/production/config/custom-environment-variables.yaml` and can be
44intuited from usage.
45
ef48a0d5
BB
46**Important**: note that you'll get the initial `root` user password from the
47program output, so check out your logs to find them.
48
b44a9630
C
49### Upgrade
50
51Pull the latest images and rerun PeerTube:
52
53```
54$ docker-compose pull
55$ PEERTUBE_WEBSERVER_HOSTNAME="domain.tld" docker-compose up
56```
57
58
59## Build your own Docker image
60
61```bash
62$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
63$ cd /tmp/peertube
64$ docker build . -f ./support/docker/production/Dockerfile.stretch
65```
66
ef48a0d5 67## Development
4df6a1b8 68
b44a9630
C
69We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop)
70for more information on how you can hack PeerTube!