]>
Commit | Line | Data |
---|---|---|
4df6a1b8 C |
1 | # Docker guide |
2 | ||
ef48a0d5 BB |
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. | |
4df6a1b8 | 6 | |
ef48a0d5 BB |
7 | ## Production |
8 | ||
b44a9630 | 9 | ### Install |
4df6a1b8 | 10 | |
6454845e C |
11 | **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start. |
12 | ||
ef48a0d5 BB |
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. | |
4df6a1b8 | 16 | |
f83e339b | 17 | ```shell |
b44a9630 C |
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 | |
f83e339b | 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 |
b44a9630 C |
23 | ``` |
24 | ||
25 | Update the reverse proxy configuration: | |
26 | ||
f83e339b | 27 | ```shell |
b44a9630 C |
28 | $ vim ./docker-volume/traefik/traefik.toml |
29 | ``` | |
30 | ||
31 | Tweak the `docker-compose.yml` file there according to your needs: | |
4df6a1b8 | 32 | |
f83e339b | 33 | ```shell |
52be3076 | 34 | $ vim ./docker-compose.yml |
b44a9630 C |
35 | ``` |
36 | ||
f83e339b | 37 | Then tweak the `.env` file to change the enviromnent variables: |
4df6a1b8 | 38 | |
f83e339b FP |
39 | ```shell |
40 | $ vim ./.env | |
ef48a0d5 BB |
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 | ||
f83e339b FP |
47 | You can use the regular `up` command to set it up: |
48 | ||
49 | ```shell | |
50 | $ docker-compose up | |
51 | ``` | |
52 | ||
ef48a0d5 BB |
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 | ||
57c36b27 C |
56 | ### What now? |
57 | ||
58 | See the production guide ["What now" section](/support/doc/production.md#what-now). | |
59 | ||
b44a9630 C |
60 | ### Upgrade |
61 | ||
62 | Pull the latest images and rerun PeerTube: | |
63 | ||
f83e339b | 64 | ```shell |
9007daff | 65 | $ cd /your/peertube/directory |
b44a9630 | 66 | $ docker-compose pull |
f83e339b | 67 | $ docker-compose up -d |
b44a9630 C |
68 | ``` |
69 | ||
70 | ||
71 | ## Build your own Docker image | |
72 | ||
f83e339b | 73 | ```shell |
b44a9630 C |
74 | $ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube |
75 | $ cd /tmp/peertube | |
76 | $ docker build . -f ./support/docker/production/Dockerfile.stretch | |
77 | ``` | |
78 | ||
ef48a0d5 | 79 | ## Development |
4df6a1b8 | 80 | |
b44a9630 | 81 | We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#develop) |
f83e339b | 82 | for more information on how you can hack PeerTube! |