mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2025-10-03 09:49:20 +02:00
297 lines
8.8 KiB
Markdown
297 lines
8.8 KiB
Markdown
# Docker guide
|
|
|
|
This guide requires [docker](https://www.docker.com/community-edition) and
|
|
[docker-compose V2](https://docs.docker.com/compose/install/).
|
|
|
|
```shell
|
|
docker compose version # Must be > 2.x.x
|
|
```
|
|
|
|
## Install
|
|
|
|
**PeerTube does not support webserver host change**. Keep in mind your domain
|
|
name is definitive after your first PeerTube start.
|
|
|
|
#### Go to your workdir
|
|
|
|
:::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
|
|
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
|
|
```
|
|
|
|
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.
|
|
|
|
#### Webserver
|
|
|
|
::: info
|
|
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.
|
|
:::
|
|
|
|
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 docker-volume/nginx-logs
|
|
curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/nginx/peertube > docker-volume/nginx/peertube
|
|
```
|
|
|
|
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.
|
|
|
|
|
|
#### 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.
|
|
|
|
Run your containers:
|
|
|
|
```shell
|
|
docker compose up
|
|
```
|
|
|
|
#### Obtaining your automatically-generated admin credentials
|
|
|
|
You can change the automatically created password for user root by running this command from peertube's root directory:
|
|
```shell
|
|
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.
|
|
|
|
```bash
|
|
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
|
|
```
|
|
|
|
#### Obtaining Your Automatically Generated DKIM DNS TXT Record
|
|
|
|
[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/).
|
|
|
|
Run `cat ./docker-volume/opendkim/keys/*/*.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain :
|
|
|
|
```bash
|
|
cat ./docker-volume/opendkim/keys/*/*.txt
|
|
|
|
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
|
|
```
|
|
|
|
#### Administrator password
|
|
|
|
See the production guide ["Administrator" section](https://docs.joinpeertube.org/install/any-os#administrator)
|
|
|
|
#### What now?
|
|
|
|
See the production guide ["What now" section](https://docs.joinpeertube.org/install/any-os#what-now).
|
|
|
|
## Upgrade
|
|
|
|
::: warning
|
|
Check the changelog (in particular the *IMPORTANT NOTES* section): https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
|
|
:::
|
|
|
|
Pull the latest images:
|
|
|
|
```shell
|
|
cd /your/peertube/directory
|
|
docker compose pull
|
|
```
|
|
|
|
Stop, delete the containers and internal volumes (to invalidate static client files shared by `peertube` and `webserver` containers):
|
|
|
|
```shell
|
|
docker compose down -v
|
|
```
|
|
|
|
Update the nginx configuration:
|
|
|
|
```shell
|
|
mv docker-volume/nginx/peertube docker-volume/nginx/peertube.bak
|
|
curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/nginx/peertube > docker-volume/nginx/peertube
|
|
```
|
|
|
|
Rerun PeerTube:
|
|
|
|
```shell
|
|
docker compose up -d
|
|
```
|
|
|
|
## Upgrade PostgreSQL container
|
|
|
|
If you want to upgrade your PostgreSQL container version (for example because your current version is about to no longer be supported),
|
|
you need to plan downtime (to export current cluster and re-import data in new one).
|
|
|
|
When you're ready, go inside your PeerTube docker compose directory:
|
|
|
|
```sh
|
|
cd /docker-compose/directory
|
|
```
|
|
|
|
Prepare the backups directory and stop all containers except the database:
|
|
|
|
```sh
|
|
mkdir -p backups
|
|
docker compose stop peertube webserver certbot
|
|
```
|
|
|
|
Go inside the database container:
|
|
|
|
```sh
|
|
docker compose exec -it postgres /bin/bash
|
|
```
|
|
|
|
And export the database (you don't need to replace `$POSTGRES_*` variables, they are automatically set by your env file from docker compose):
|
|
|
|
```sh
|
|
export PGUSER="$POSTGRES_USER"
|
|
export PGDATABASE="$POSTGRES_DB"
|
|
export PGPASSWORD="$POSTGRES_PASSWORD"
|
|
pg_dumpall > "/tmp/pg.dump"
|
|
```
|
|
|
|
Exit the container:
|
|
|
|
```sh
|
|
exit
|
|
```
|
|
|
|
Copy the dump from the container:
|
|
|
|
```sh
|
|
docker compose cp postgres:/tmp/pg.dump backups/pg.dump
|
|
```
|
|
|
|
|
|
Stop the database container and prepare the data for the new cluster:
|
|
|
|
```sh
|
|
docker compose stop postgres
|
|
mv ./docker-volume/db ./docker-volume/db.bak
|
|
mkdir ./docker-volume/db && chmod 700 ./docker-volume/db
|
|
```
|
|
|
|
Upgrade your PostgreSQL container version (for example replace `postgres:13-alpine` by `postgres:17-alpine`):
|
|
|
|
```sh
|
|
vim docker-compose.yml
|
|
```
|
|
|
|
Pull new PostgreSQL Docker image:
|
|
|
|
```sh
|
|
docker compose pull
|
|
```
|
|
|
|
Restart PostgreSQL only container and wait until you see: `database system is ready to accept connections`
|
|
|
|
```sh
|
|
docker compose up -d postgres
|
|
docker compose logs -f postgres
|
|
```
|
|
|
|
Copy the database dump inside the container:
|
|
|
|
```sh
|
|
docker compose cp "backups/pg.dump" postgres:/tmp/pg.dump
|
|
```
|
|
|
|
Go inside the container
|
|
|
|
```sh
|
|
docker compose exec -it postgres /bin/bash
|
|
```
|
|
|
|
Check the PostgreSQL version and re-import database data.
|
|
Then, reset the PeerTube database user password to fix a potential authentication issue if the old password hash algorithm has been deprecated.
|
|
|
|
```sh
|
|
export PGUSER="$POSTGRES_USER"
|
|
export PGDATABASE="$POSTGRES_DB"
|
|
export PGPASSWORD="$POSTGRES_PASSWORD"
|
|
psql -U "$POSTGRES_USER" -c "SELECT version();"
|
|
psql -U "$POSTGRES_USER" -f /tmp/pg.dump
|
|
psql -U "$POSTGRES_USER" -c "ALTER USER $POSTGRES_USER WITH PASSWORD '$POSTGRES_PASSWORD'"
|
|
```
|
|
|
|
Exit the container:
|
|
|
|
```sh
|
|
exit
|
|
```
|
|
|
|
Restart other services and check everything is fine:
|
|
|
|
```sh
|
|
docker compose up -d peertube webserver certbot
|
|
docker compose logs -f peertube
|
|
```
|
|
|
|
|
|
If you're happy with the results, you can remove backups directory and old data directories:
|
|
|
|
```sh
|
|
rm -rf ./docker-volume/db.bak backups
|
|
```
|
|
|
|
## Build
|
|
|
|
### Production
|
|
|
|
```shell
|
|
git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
|
|
cd /tmp/peertube
|
|
docker build . -f ./support/docker/production/Dockerfile
|
|
```
|
|
|
|
### Development
|
|
|
|
We don't have a Docker image for development. See [the CONTRIBUTING guide](https://docs.joinpeertube.org/contribute/getting-started#develop) for more information on how you can hack PeerTube!
|