]>
Commit | Line | Data |
---|---|---|
4df6a1b8 C |
1 | # Docker guide |
2 | ||
b8f3e6b0 | 3 | This guide requires [docker](https://www.docker.com/community-edition) and |
a30995fc | 4 | [docker-compose](https://docs.docker.com/compose/install/). |
4df6a1b8 | 5 | |
f930450a | 6 | ## Install |
4df6a1b8 | 7 | |
83d4aba6 | 8 | **PeerTube does not support webserver host change**. Keep in mind your domain |
b8f3e6b0 | 9 | name is definitive after your first PeerTube start. |
4df6a1b8 | 10 | |
a30995fc RK |
11 | #### Go to your workdir |
12 | ||
13 | _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`. | |
b44a9630 | 14 | |
e962e1c3 | 15 | ```shell |
b8f3e6b0 | 16 | cd /your/peertube/directory |
e962e1c3 K |
17 | ``` |
18 | ||
19 | #### Get the latest Compose file | |
20 | ||
21 | ```shell | |
c9595426 | 22 | curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml |
e962e1c3 K |
23 | ``` |
24 | ||
c9595426 | 25 | View the source of the file you're about to download: [docker-compose.yml](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/docker-compose.yml) |
e962e1c3 | 26 | |
e962e1c3 K |
27 | #### Get the latest env_file |
28 | ||
29 | ```shell | |
c9595426 | 30 | curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env > .env |
e962e1c3 K |
31 | ``` |
32 | ||
c9595426 | 33 | View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env) |
e962e1c3 | 34 | |
e962e1c3 K |
35 | #### Tweak the `docker-compose.yml` file there according to your needs |
36 | ||
37 | ```shell | |
b8f3e6b0 | 38 | $EDITOR ./docker-compose.yml |
e962e1c3 K |
39 | ``` |
40 | ||
a30995fc | 41 | #### Then tweak the `.env` file to change the environment variables settings |
e962e1c3 K |
42 | |
43 | ```shell | |
b8f3e6b0 | 44 | $EDITOR ./.env |
e962e1c3 | 45 | ``` |
b8f3e6b0 | 46 | |
c9595426 | 47 | In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env), you must replace: |
e962e1c3 K |
48 | - `<MY POSTGRES USERNAME>` |
49 | - `<MY POSTGRES PASSWORD>` | |
e962e1c3 K |
50 | - `<MY DOMAIN>` without 'https://' |
51 | - `<MY EMAIL ADDRESS>` | |
1ea868a9 | 52 | - `<MY PEERTUBE SECRET>` |
ef48a0d5 BB |
53 | |
54 | Other environment variables are used in | |
c9595426 | 55 | [/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 |
ef48a0d5 BB |
56 | intuited from usage. |
57 | ||
afd4ee86 | 58 | #### Webserver |
e962e1c3 | 59 | |
afd4ee86 C |
60 | *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.* |
61 | ||
62 | Install the template that the nginx container will use. | |
63 | The container will generate the configuration by replacing `${WEBSERVER_HOST}` and `${PEERTUBE_HOST}` using your docker compose env file. | |
64 | ||
afd4ee86 C |
65 | ```shell |
66 | mkdir -p docker-volume/nginx | |
c9595426 | 67 | curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/nginx/peertube > docker-volume/nginx/peertube |
e962e1c3 | 68 | ``` |
afd4ee86 C |
69 | |
70 | You need to manually generate the first SSL/TLS certificate using Let's Encrypt: | |
71 | ||
72 | ```shell | |
73 | mkdir -p docker-volume/certbot | |
74 | docker run -it --rm --name certbot -p 80:80 -v "$(pwd)/docker-volume/certbot/conf:/etc/letsencrypt" certbot/certbot certonly --standalone | |
e962e1c3 K |
75 | ``` |
76 | ||
0a0e0d08 | 77 | A dedicated container in the docker-compose will automatically renew this certificate and reload nginx. |
afd4ee86 C |
78 | |
79 | ||
80 | #### Test your setup | |
81 | ||
82 | Run your containers: | |
f83e339b FP |
83 | |
84 | ```shell | |
e962e1c3 | 85 | docker-compose up |
f83e339b | 86 | ``` |
b8f3e6b0 | 87 | |
f930450a | 88 | #### Obtaining your automatically-generated admin credentials |
b8f3e6b0 RK |
89 | |
90 | 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. | |
91 | ||
92 | ```bash | |
a30995fc | 93 | $ docker-compose logs peertube | grep -A1 root |
76d5770b L |
94 | |
95 | peertube_1 | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root | |
96 | peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop | |
97 | ``` | |
ef48a0d5 | 98 | |
f930450a | 99 | #### Obtaining Your Automatically Generated DKIM DNS TXT Record |
b8f3e6b0 | 100 | |
cd7ec86f | 101 | [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/). |
b8f3e6b0 | 102 | |
83d4aba6 | 103 | Run `cat ./docker-volume/opendkim/keys/*/*.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain : |
b8f3e6b0 RK |
104 | |
105 | ```bash | |
a30995fc | 106 | $ cat ./docker-volume/opendkim/keys/*/*.txt |
cd7ec86f | 107 | |
108 | peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; " | |
109 | "p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Dx7wLGPFVaxVQ4TGym/eF89aQ8oMxS9v5BCc26Hij91t2Ci8Fl12DHNVqZoIPGm+9tTIoDVDFEFrlPhMOZl8i4jU9pcFjjaIISaV2+qTa8uV1j3MyByogG8pu4o5Ill7zaySYFsYB++cHJ9pjbFSC42dddCYMfuVgrBsLNrvEi3dLDMjJF5l92Uu8YeswFe26PuHX3Avr261n" | |
110 | "j5joTnYwat4387VEUyGUnZ0aZxCERi+ndXv2/wMJ0tizq+a9+EgqIb+7lkUc2XciQPNuTujM25GhrQBEKznvHyPA6fHsFheymOuB763QpkmnQQLCxyLygAY9mE/5RY+5Q6J9oDOQIDAQAB" ) ; ----- DKIM key peertube for mydomain.tld | |
111 | ``` | |
112 | ||
f930450a | 113 | #### Administrator password |
23cbb0f3 | 114 | |
ac30ddd7 | 115 | See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=technologist-administrator) |
23cbb0f3 | 116 | |
f930450a | 117 | #### What now? |
57c36b27 | 118 | |
ac30ddd7 | 119 | See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=tada-what-now). |
57c36b27 | 120 | |
f930450a | 121 | ## Upgrade |
b44a9630 | 122 | |
c9595426 | 123 | **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). |
e359e88b | 124 | |
b826b339 | 125 | Pull the latest images: |
b44a9630 | 126 | |
f83e339b | 127 | ```shell |
9007daff | 128 | $ cd /your/peertube/directory |
b44a9630 | 129 | $ docker-compose pull |
14d3bb9c | 130 | ``` |
b826b339 C |
131 | |
132 | Stop, delete the containers and internal volumes (to invalidate static client files shared by `peertube` and `webserver` containers): | |
133 | ||
134 | ```shell | |
135 | $ docker-compose down -v | |
136 | ``` | |
137 | ||
138 | Rerun PeerTube: | |
139 | ||
140 | ```shell | |
f83e339b | 141 | $ docker-compose up -d |
b44a9630 C |
142 | ``` |
143 | ||
f930450a C |
144 | ## Build |
145 | ||
146 | ### Production | |
b44a9630 | 147 | |
f83e339b | 148 | ```shell |
b44a9630 C |
149 | $ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube |
150 | $ cd /tmp/peertube | |
1606ac20 | 151 | $ docker build . -f ./support/docker/production/Dockerfile.bullseye |
b44a9630 C |
152 | ``` |
153 | ||
f930450a | 154 | ### Development |
4df6a1b8 | 155 | |
83d4aba6 | 156 | 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! |