PeerTube/support/doc/docker.md

174 lines
5.9 KiB
Markdown
Raw Normal View History

2018-01-29 11:23:38 +01:00
# Docker guide
2020-06-22 13:06:54 +02:00
This guide requires [docker](https://www.docker.com/community-edition) and
2023-04-14 09:30:45 +02:00
[docker-compose V2](https://docs.docker.com/compose/install/).
```shell
docker compose version # Must be > 2.x.x
```
2018-01-29 11:23:38 +01:00
2021-01-12 09:40:05 +01:00
## Install
2018-01-29 11:23:38 +01:00
2020-12-30 14:39:52 +01:00
**PeerTube does not support webserver host change**. Keep in mind your domain
2020-06-22 13:06:54 +02:00
name is definitive after your first PeerTube start.
2018-01-29 11:23:38 +01:00
#### Go to your workdir
2023-04-14 09:30:45 +02:00
:::info
The guide that follows assumes an empty workdir, but you can also clone the repository, use the master branch and `cd support/docker/production`.
:::
```shell
2020-06-22 13:06:54 +02:00
cd /your/peertube/directory
```
#### Get the latest Compose file
```shell
curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml
```
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)
#### Get the latest env_file
```shell
curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env > .env
```
View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env)
#### Tweak the `docker-compose.yml` file there according to your needs
```shell
sudo nano docker-compose.yml
```
#### Then tweak the `.env` file to change the environment variables settings
```shell
sudo nano .env
```
2020-06-22 13:06:54 +02:00
In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env), you must replace:
- `<MY POSTGRES USERNAME>`
- `<MY POSTGRES PASSWORD>`
- `<MY DOMAIN>` without 'https://'
- `<MY EMAIL ADDRESS>`
- `<MY PEERTUBE SECRET>`
Other environment variables are used in
[/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
intuited from usage.
2020-12-30 16:53:11 +01:00
#### Webserver
2023-04-14 09:30:45 +02:00
::: info
2023-05-16 10:38:04 +02:00
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.
:::
2020-12-30 16:53:11 +01:00
Install the template that the nginx container will use.
The container will generate the configuration by replacing `${WEBSERVER_HOST}` and `${PEERTUBE_HOST}` using your docker compose env file.
```shell
mkdir -p docker-volume/nginx
curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/nginx/peertube > docker-volume/nginx/peertube
```
2020-12-30 16:53:11 +01:00
You need to manually generate the first SSL/TLS certificate using Let's Encrypt:
```shell
mkdir -p docker-volume/certbot
docker run -it --rm --name certbot -p 80:80 -v "$(pwd)/docker-volume/certbot/conf:/etc/letsencrypt" certbot/certbot certonly --standalone
```
A dedicated container in the docker-compose will automatically renew this certificate and reload nginx.
2020-12-30 16:53:11 +01:00
#### Test your setup
_note_: Newer versions of compose are called with `docker compose` instead of `docker-compose`, so remove the dash in all steps that use this command if you are getting errors.
2020-12-30 16:53:11 +01:00
Run your containers:
```shell
2023-05-16 10:38:04 +02:00
docker compose up
```
2020-06-22 13:06:54 +02:00
2021-01-12 09:40:05 +01:00
#### Obtaining your automatically-generated admin credentials
2020-06-22 13:06:54 +02:00
You can change the automatically created password for user root by running this command from peertube's root directory:
```shell
2023-05-16 10:38:04 +02:00
docker compose exec -u peertube peertube npm run reset-password -- -u root
```
You can also grep your peertube container's logs for the default `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.
2020-06-22 13:06:54 +02:00
```bash
2023-05-16 10:38:04 +02:00
docker compose logs peertube | grep -A1 root
peertube_1 | [example.com:443] 2019-11-16 04:26:06.082 info: Username: root
peertube_1 | [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop
```
2021-01-12 09:40:05 +01:00
#### Obtaining Your Automatically Generated DKIM DNS TXT Record
2020-06-22 13:06:54 +02:00
2020-03-10 15:14:19 +01:00
[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/).
2020-06-22 13:06:54 +02:00
2020-12-30 14:39:52 +01:00
Run `cat ./docker-volume/opendkim/keys/*/*.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain :
2020-06-22 13:06:54 +02:00
```bash
cat ./docker-volume/opendkim/keys/*/*.txt
2020-03-10 15:14:19 +01:00
peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; "
"p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Dx7wLGPFVaxVQ4TGym/eF89aQ8oMxS9v5BCc26Hij91t2Ci8Fl12DHNVqZoIPGm+9tTIoDVDFEFrlPhMOZl8i4jU9pcFjjaIISaV2+qTa8uV1j3MyByogG8pu4o5Ill7zaySYFsYB++cHJ9pjbFSC42dddCYMfuVgrBsLNrvEi3dLDMjJF5l92Uu8YeswFe26PuHX3Avr261n"
"j5joTnYwat4387VEUyGUnZ0aZxCERi+ndXv2/wMJ0tizq+a9+EgqIb+7lkUc2XciQPNuTujM25GhrQBEKznvHyPA6fHsFheymOuB763QpkmnQQLCxyLygAY9mE/5RY+5Q6J9oDOQIDAQAB" ) ; ----- DKIM key peertube for mydomain.tld
```
2021-01-12 09:40:05 +01:00
#### Administrator password
2020-09-10 09:19:24 +02:00
2023-02-23 09:46:43 +01:00
See the production guide ["Administrator" section](https://docs.joinpeertube.org/install/any-os#administrator)
2020-09-10 09:19:24 +02:00
2021-01-12 09:40:05 +01:00
#### What now?
2018-07-19 16:17:54 +02:00
2023-02-23 09:46:43 +01:00
See the production guide ["What now" section](https://docs.joinpeertube.org/install/any-os#what-now).
2018-07-19 16:17:54 +02:00
2021-01-12 09:40:05 +01:00
## Upgrade
2023-04-14 09:30:45 +02:00
::: warning
Check the changelog (in particular the *IMPORTANT NOTES* section):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
:::
2021-01-08 11:51:55 +01:00
Pull the latest images:
```shell
cd /your/peertube/directory
2023-05-16 10:38:04 +02:00
docker compose pull
2021-01-08 11:54:33 +01:00
```
2021-01-08 11:51:55 +01:00
Stop, delete the containers and internal volumes (to invalidate static client files shared by `peertube` and `webserver` containers):
```shell
2023-05-16 10:38:04 +02:00
docker compose down -v
2021-01-08 11:51:55 +01:00
```
Rerun PeerTube:
```shell
2023-05-16 10:38:04 +02:00
docker compose up -d
```
2021-01-12 09:40:05 +01:00
## Build
### Production
```shell
git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
cd /tmp/peertube
docker build . -f ./support/docker/production/Dockerfile.bullseye
```
2021-01-12 09:40:05 +01:00
### Development
2018-01-29 11:23:38 +01:00
2020-12-30 14:39:52 +01:00
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!