docker.md 5.9 KB
Docker guide
This guide requires docker and docker-compose.
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
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.
cd /your/peertube/directory
Get the latest Compose file
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
Get the latest env_file
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
Tweak the docker-compose.yml file there according to your needs
sudo nano docker-compose.yml
Then tweak the .env file to change the environment variables settings
sudo nano .env
In the downloaded example .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 and can be intuited from usage.
Webserver
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.
mkdir -p docker-volume/nginx
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:
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:
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:
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.
$ 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 signature sending and RSA keys generation are enabled by the default Postfix image mwader/postfix-relay with OpenDKIM.
Run cat ./docker-volume/opendkim/keys/*/*.txt to display your DKIM DNS TXT Record containing the public key to configure to your domain :
$ 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
What now?
See the production guide "What now" section.
Upgrade
Check the changelog (in particular the IMPORTANT NOTES section): https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
Pull the latest images:
$ 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):
$ docker-compose down -v
Rerun PeerTube:
$ docker-compose up -d
Build
Production
$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
$ cd /tmp/peertube
$ docker build . -f ./support/docker/production/Dockerfile.bullseye
Development
We don't have a Docker image for development. See the CONTRIBUTING guide for more information on how you can hack PeerTube!