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