[github/Chocobozzz/PeerTube.git] / support / doc / docker.md

# Docker guide

This guide requires [docker](https://www.docker.com/community-edition) and
[docker-compose](https://docs.docker.com/compose/install/).

## Production

### 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`.

```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
$EDITOR ./docker-compose.yml
```

#### Then tweak the `.env` file to change the environment variables settings

```shell
$EDITOR ./.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>`

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.

#### Testing local Docker setup

To test locally your Docker setup, you must add your domain (`<MY DOMAIN>`) in `/etc/hosts`:
```
127.0.0.1       localhost   mydomain.tld
```

#### You can use the regular `up` command to set it up

```shell
docker-compose up
```

### Obtaining your automatically-generated admin credentials

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.

```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?id=administrator)

### What now?

See the production guide ["What now" section](https://docs.joinpeertube.org/#/install-any-os?id=what-now).

### Upgrade

**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).

Pull the latest images and rerun PeerTube:

```shell
$ cd /your/peertube/directory
$ docker-compose pull
$ docker-compose up -d
```

## Build your own Docker image

```shell
$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
$ cd /tmp/peertube
$ docker build . -f ./support/docker/production/Dockerfile.buster
```

## Development

We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md#develop) for more information on how you can hack PeerTube!
Commit	Line	Data
	1	# Docker guide
	2
	3	This guide requires [docker](https://www.docker.com/community-edition) and
	4	[docker-compose](https://docs.docker.com/compose/install/).
	5
	6	## Production
	7
	8	### Install
	9
	10	PeerTube does not support webserver host change. Keep in mind your domain
	11	name is definitive after your first PeerTube start.
	12
	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`.
	16
	17	```shell
	18	cd /your/peertube/directory
	19	```
	20
	21	#### Get the latest Compose file
	22
	23	```shell
	24	curl https://raw.githubusercontent.com/chocobozzz/PeerTube/master/support/docker/production/docker-compose.yml > docker-compose.yml
	25	```
	26
	27	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)
	28
	29	#### Get the latest env_file
	30
	31	```shell
	32	curl https://raw.githubusercontent.com/Chocobozzz/PeerTube/master/support/docker/production/.env > .env
	33	```
	34
	35	View the source of the file you're about to download: [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env)
	36
	37	#### Tweak the `docker-compose.yml` file there according to your needs
	38
	39	```shell
	40	$EDITOR ./docker-compose.yml
	41	```
	42
	43	#### Then tweak the `.env` file to change the environment variables settings
	44
	45	```shell
	46	$EDITOR ./.env
	47	```
	48
	49	In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env), you must replace:
	50	- `<MY POSTGRES USERNAME>`
	51	- `<MY POSTGRES PASSWORD>`
	52	- `<MY DOMAIN>` without 'https://'
	53	- `<MY EMAIL ADDRESS>`
	54
	55	Other environment variables are used in
	56	[/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
	57	intuited from usage.
	58
	59	#### Testing local Docker setup
	60
	61	To test locally your Docker setup, you must add your domain (`<MY DOMAIN>`) in `/etc/hosts`:
	62	```
	63	127.0.0.1 localhost mydomain.tld
	64	```
	65
	66	#### You can use the regular `up` command to set it up
	67
	68	```shell
	69	docker-compose up
	70	```
	71
	72	### Obtaining your automatically-generated admin credentials
	73
	74	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.
	75
	76	```bash
	77	$ docker-compose logs peertube \| grep -A1 root
	78
	79	peertube_1 \| [example.com:443] 2019-11-16 04:26:06.082 info: Username: root
	80	peertube_1 \| [example.com:443] 2019-11-16 04:26:06.083 info: User password: abcdefghijklmnop
	81	```
	82
	83	### Obtaining Your Automatically Generated DKIM DNS TXT Record
	84
	85	[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/).
	86
	87	Run `cat ./docker-volume/opendkim/keys//.txt` to display your DKIM DNS TXT Record containing the public key to configure to your domain :
	88
	89	```bash
	90	$ cat ./docker-volume/opendkim/keys//.txt
	91
	92	peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; "
	93	"p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Dx7wLGPFVaxVQ4TGym/eF89aQ8oMxS9v5BCc26Hij91t2Ci8Fl12DHNVqZoIPGm+9tTIoDVDFEFrlPhMOZl8i4jU9pcFjjaIISaV2+qTa8uV1j3MyByogG8pu4o5Ill7zaySYFsYB++cHJ9pjbFSC42dddCYMfuVgrBsLNrvEi3dLDMjJF5l92Uu8YeswFe26PuHX3Avr261n"
	94	"j5joTnYwat4387VEUyGUnZ0aZxCERi+ndXv2/wMJ0tizq+a9+EgqIb+7lkUc2XciQPNuTujM25GhrQBEKznvHyPA6fHsFheymOuB763QpkmnQQLCxyLygAY9mE/5RY+5Q6J9oDOQIDAQAB" ) ; ----- DKIM key peertube for mydomain.tld
	95	```
	96
	97	### Administrator password
	98
	99	See the production guide ["Administrator" section](https://docs.joinpeertube.org/#/install-any-os?id=administrator)
	100
	101	### What now?
	102
	103	See the production guide ["What now" section](https://docs.joinpeertube.org/#/install-any-os?id=what-now).
	104
	105	### Upgrade
	106
	107	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).
	108
	109	Pull the latest images and rerun PeerTube:
	110
	111	```shell
	112	$ cd /your/peertube/directory
	113	$ docker-compose pull
	114	$ docker-compose up -d
	115	```
	116
	117	## Build your own Docker image
	118
	119	```shell
	120	$ git clone https://github.com/chocobozzz/PeerTube /tmp/peertube
	121	$ cd /tmp/peertube
	122	$ docker build . -f ./support/docker/production/Dockerfile.buster
	123	```
	124
	125	## Development
	126
	127	We don't have a Docker image for development. See [the CONTRIBUTING guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md#develop) for more information on how you can hack PeerTube!