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

# Production guide

  * [Installation](#installation)
  * [Upgrade](#upgrade)

## Installation

Please don't install PeerTube for production on a device behind a low bandwidth connection (example: your ADSL link).
If you want information about the appropriate hardware to run PeerTube, please see the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube).

### Dependencies

**Follow the steps of the [dependencies guide](dependencies.md).**

### PeerTube user

Create a `peertube` user with `/var/www/peertube` home:

```
$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
```

Set its password:
```
$ sudo passwd peertube
```

**On FreeBSD**

```
$ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
$ sudo passwd peertube
```
or use `adduser` to create it interactively.

### Database

Create the production database and a peertube user inside PostgreSQL:

```
$ sudo -u postgres createuser -P peertube
$ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
```

Then enable extensions PeerTube needs:

```
$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
```

### Prepare PeerTube directory

Fetch the latest tagged version of Peertube
```
$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && echo "Latest Peertube version is $VERSION"
```

Open the peertube directory, create a few required directories
```
$ cd /var/www/peertube
$ sudo -u peertube mkdir config storage versions
```

Download the latest version of the Peertube client, unzip it and remove the zip
```
$ cd /var/www/peertube/versions
$ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
$ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
```

Install Peertube:
```
$ cd /var/www/peertube
$ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
$ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
```

### PeerTube configuration

Copy the default configuration file that contains the default configuration provided by PeerTube.
You **must not** update this file.

```
$ cd /var/www/peertube
$ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
```

Now copy the production example configuration:

```
$ cd /var/www/peertube
$ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
```

Then edit the `config/production.yaml` file according to your webserver
and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.

**PeerTube does not support webserver host change**. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/maintain-tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors.

### Webserver

We only provide official configuration files for Nginx.

Copy the nginx configuration template:

```
$ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
```

Then set the domain for the webserver configuration file.
Replace `[peertube-domain]` with the domain for the peertube server.

```
$ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
$ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
```

Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).

```
$ sudo vim /etc/nginx/sites-available/peertube
```

Activate the configuration file:

```
$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
```

To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):

```
$ sudo systemctl stop nginx
$ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
$ sudo systemctl reload nginx
```

Now you have the certificates you can reload nginx:

```
$ sudo systemctl reload nginx
```

Certbot should have installed a cron to automatically renew your certificate.
Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:

```
$ # Replace authenticator = standalone by authenticator = webroot
$ # Add webroot_path = /var/www/certbot
$ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
```

**FreeBSD**
On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)

```
$ sudo pkg install dehydrated
```

### TCP/IP Tuning

**On Linux**

```
$ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
$ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
```

Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
links as we often encounter in a video server.

### systemd

If your OS uses systemd, copy the configuration template:

```
$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
```

Check the service file (PeerTube paths and security directives):

```
$ sudo vim /etc/systemd/system/peertube.service
```


Tell systemd to reload its config:

```
$ sudo systemctl daemon-reload
```

If you want to start PeerTube on boot:

```
$ sudo systemctl enable peertube
```

Run:

```
$ sudo systemctl start peertube
$ sudo journalctl -feu peertube
```

**FreeBSD**
On FreeBSD, copy the startup script and update rc.conf:

```
$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
$ sudo sysrc peertube_enable="YES"
```

Run:

```
$ sudo service peertube start
```

### OpenRC

If your OS uses OpenRC, copy the service script:

```
$ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
```

If you want to start PeerTube on boot:

```
$ sudo rc-update add peertube default
```

Run and print last logs:

```
$ sudo /etc/init.d/peertube start
$ tail -f /var/log/peertube/peertube.log
```

### Administrator

The administrator password is automatically generated and can be found in the PeerTube
logs (path defined in `production.yaml`). You can also set another password with:

```
$ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
```

Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
to your own administrator password, although it must be 6 characters or more.

### What now?

Now your instance is up you can:

 * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
 * Check [available CLI tools](/support/doc/tools.md)

## Upgrade

### PeerTube instance

**Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md

#### Auto

The password it asks is PeerTube's database user password.

```
$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
```

#### Manually

Make a SQL backup

```
$ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
    cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
    sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
```

Fetch the latest tagged version of Peertube:

```
$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && echo "Latest Peertube version is $VERSION"
```

Download the new version and unzip it:

```
$ cd /var/www/peertube/versions && \
    sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
    sudo -u peertube unzip -o peertube-${VERSION}.zip && \
    sudo -u peertube rm peertube-${VERSION}.zip
```

Install node dependencies:

```
$ cd /var/www/peertube/versions/peertube-${VERSION} && \
    sudo -H -u peertube yarn install --production --pure-lockfile
```

Copy new configuration defaults values and update your configuration file:

```
$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
$ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
```

Change the link to point to the latest version:

```
$ cd /var/www/peertube && \
    sudo unlink ./peertube-latest && \
    sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
```

### nginx

Check changes in nginx configuration:

```
$ cd /var/www/peertube/versions
$ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
```

### systemd

Check changes in systemd configuration:

```
$ cd /var/www/peertube/versions
$ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
```

### Restart PeerTube

If you changed your nginx configuration:

```
$ sudo systemctl reload nginx
```

If you changed your systemd configuration:

```
$ sudo systemctl daemon-reload
```

Restart PeerTube and check the logs:

```
$ sudo systemctl restart peertube && sudo journalctl -fu peertube
```

### Things went wrong?

Change `peertube-latest` destination to the previous version and restore your SQL backup:

```
$ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
    cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
    sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
    sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
    sudo systemctl restart peertube
```
Commit	Line	Data
	1	# Production guide
	2
	3	* [Installation](#installation)
	4	* [Upgrade](#upgrade)
	5
	6	## Installation
	7
	8	Please don't install PeerTube for production on a device behind a low bandwidth connection (example: your ADSL link).
	9	If you want information about the appropriate hardware to run PeerTube, please see the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube).
	10
	11	### Dependencies
	12
	13	Follow the steps of the [dependencies guide](dependencies.md).
	14
	15	### PeerTube user
	16
	17	Create a `peertube` user with `/var/www/peertube` home:
	18
	19	```
	20	$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
	21	```
	22
	23	Set its password:
	24	```
	25	$ sudo passwd peertube
	26	```
	27
	28	On FreeBSD
	29
	30	```
	31	$ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
	32	$ sudo passwd peertube
	33	```
	34	or use `adduser` to create it interactively.
	35
	36	### Database
	37
	38	Create the production database and a peertube user inside PostgreSQL:
	39
	40	```
	41	$ sudo -u postgres createuser -P peertube
	42	$ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
	43	```
	44
	45	Then enable extensions PeerTube needs:
	46
	47	```
	48	$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
	49	$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
	50	```
	51
	52	### Prepare PeerTube directory
	53
	54	Fetch the latest tagged version of Peertube
	55	```
	56	$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest \| grep tag_name \| cut -d '"' -f 4) && echo "Latest Peertube version is $VERSION"
	57	```
	58
	59	Open the peertube directory, create a few required directories
	60	```
	61	$ cd /var/www/peertube
	62	$ sudo -u peertube mkdir config storage versions
	63	```
	64
	65	Download the latest version of the Peertube client, unzip it and remove the zip
	66	```
	67	$ cd /var/www/peertube/versions
	68	$ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
	69	$ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
	70	```
	71
	72	Install Peertube:
	73	```
	74	$ cd /var/www/peertube
	75	$ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
	76	$ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
	77	```
	78
	79	### PeerTube configuration
	80
	81	Copy the default configuration file that contains the default configuration provided by PeerTube.
	82	You must not update this file.
	83
	84	```
	85	$ cd /var/www/peertube
	86	$ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
	87	```
	88
	89	Now copy the production example configuration:
	90
	91	```
	92	$ cd /var/www/peertube
	93	$ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
	94	```
	95
	96	Then edit the `config/production.yaml` file according to your webserver
	97	and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
	98	Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
	99
	100	PeerTube does not support webserver host change. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/maintain-tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors.
	101
	102	### Webserver
	103
	104	We only provide official configuration files for Nginx.
	105
	106	Copy the nginx configuration template:
	107
	108	```
	109	$ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
	110	```
	111
	112	Then set the domain for the webserver configuration file.
	113	Replace `[peertube-domain]` with the domain for the peertube server.
	114
	115	```
	116	$ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
	117	$ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
	118	```
	119
	120	Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
	121	It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
	122
	123	```
	124	$ sudo vim /etc/nginx/sites-available/peertube
	125	```
	126
	127	Activate the configuration file:
	128
	129	```
	130	$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
	131	```
	132
	133	To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
	134
	135	```
	136	$ sudo systemctl stop nginx
	137	$ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
	138	$ sudo systemctl reload nginx
	139	```
	140
	141	Now you have the certificates you can reload nginx:
	142
	143	```
	144	$ sudo systemctl reload nginx
	145	```
	146
	147	Certbot should have installed a cron to automatically renew your certificate.
	148	Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:
	149
	150	```
	151	$ # Replace authenticator = standalone by authenticator = webroot
	152	$ # Add webroot_path = /var/www/certbot
	153	$ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
	154	```
	155
	156	FreeBSD
	157	On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
	158
	159	```
	160	$ sudo pkg install dehydrated
	161	```
	162
	163	### TCP/IP Tuning
	164
	165	On Linux
	166
	167	```
	168	$ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
	169	$ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
	170	```
	171
	172	Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
	173	scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
	174	links as we often encounter in a video server.
	175
	176	### systemd
	177
	178	If your OS uses systemd, copy the configuration template:
	179
	180	```
	181	$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
	182	```
	183
	184	Check the service file (PeerTube paths and security directives):
	185
	186	```
	187	$ sudo vim /etc/systemd/system/peertube.service
	188	```
	189
	190
	191	Tell systemd to reload its config:
	192
	193	```
	194	$ sudo systemctl daemon-reload
	195	```
	196
	197	If you want to start PeerTube on boot:
	198
	199	```
	200	$ sudo systemctl enable peertube
	201	```
	202
	203	Run:
	204
	205	```
	206	$ sudo systemctl start peertube
	207	$ sudo journalctl -feu peertube
	208	```
	209
	210	FreeBSD
	211	On FreeBSD, copy the startup script and update rc.conf:
	212
	213	```
	214	$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
	215	$ sudo sysrc peertube_enable="YES"
	216	```
	217
	218	Run:
	219
	220	```
	221	$ sudo service peertube start
	222	```
	223
	224	### OpenRC
	225
	226	If your OS uses OpenRC, copy the service script:
	227
	228	```
	229	$ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
	230	```
	231
	232	If you want to start PeerTube on boot:
	233
	234	```
	235	$ sudo rc-update add peertube default
	236	```
	237
	238	Run and print last logs:
	239
	240	```
	241	$ sudo /etc/init.d/peertube start
	242	$ tail -f /var/log/peertube/peertube.log
	243	```
	244
	245	### Administrator
	246
	247	The administrator password is automatically generated and can be found in the PeerTube
	248	logs (path defined in `production.yaml`). You can also set another password with:
	249
	250	```
	251	$ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
	252	```
	253
	254	Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
	255	to your own administrator password, although it must be 6 characters or more.
	256
	257	### What now?
	258
	259	Now your instance is up you can:
	260
	261	* Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
	262	* Check [available CLI tools](/support/doc/tools.md)
	263
	264	## Upgrade
	265
	266	### PeerTube instance
	267
	268	Check the changelog (in particular BREAKING CHANGES!): https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
	269
	270	#### Auto
	271
	272	The password it asks is PeerTube's database user password.
	273
	274	```
	275	$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
	276	```
	277
	278	#### Manually
	279
	280	Make a SQL backup
	281
	282	```
	283	$ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
	284	cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
	285	sudo -u postgres pg_dump -F c peertube_prod \| sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
	286	```
	287
	288	Fetch the latest tagged version of Peertube:
	289
	290	```
	291	$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest \| grep tag_name \| cut -d '"' -f 4) && echo "Latest Peertube version is $VERSION"
	292	```
	293
	294	Download the new version and unzip it:
	295
	296	```
	297	$ cd /var/www/peertube/versions && \
	298	sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
	299	sudo -u peertube unzip -o peertube-${VERSION}.zip && \
	300	sudo -u peertube rm peertube-${VERSION}.zip
	301	```
	302
	303	Install node dependencies:
	304
	305	```
	306	$ cd /var/www/peertube/versions/peertube-${VERSION} && \
	307	sudo -H -u peertube yarn install --production --pure-lockfile
	308	```
	309
	310	Copy new configuration defaults values and update your configuration file:
	311
	312	```
	313	$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
	314	$ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
	315	```
	316
	317	Change the link to point to the latest version:
	318
	319	```
	320	$ cd /var/www/peertube && \
	321	sudo unlink ./peertube-latest && \
	322	sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
	323	```
	324
	325	### nginx
	326
	327	Check changes in nginx configuration:
	328
	329	```
	330	$ cd /var/www/peertube/versions
	331	$ diff "$(ls --sort=t \| head -2 \| tail -1)/support/nginx/peertube" "$(ls --sort=t \| head -1)/support/nginx/peertube"
	332	```
	333
	334	### systemd
	335
	336	Check changes in systemd configuration:
	337
	338	```
	339	$ cd /var/www/peertube/versions
	340	$ diff "$(ls --sort=t \| head -2 \| tail -1)/support/systemd/peertube.service" "$(ls --sort=t \| head -1)/support/systemd/peertube.service"
	341	```
	342
	343	### Restart PeerTube
	344
	345	If you changed your nginx configuration:
	346
	347	```
	348	$ sudo systemctl reload nginx
	349	```
	350
	351	If you changed your systemd configuration:
	352
	353	```
	354	$ sudo systemctl daemon-reload
	355	```
	356
	357	Restart PeerTube and check the logs:
	358
	359	```
	360	$ sudo systemctl restart peertube && sudo journalctl -fu peertube
	361	```
	362
	363	### Things went wrong?
	364
	365	Change `peertube-latest` destination to the previous version and restore your SQL backup:
	366
	367	```
	368	$ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
	369	cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
	370	sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
	371	sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
	372	sudo systemctl restart peertube
	373	```