2018-01-12 12:07:41 -05:00
# Production guide
2018-01-29 05:23:38 -05:00
* [Installation ](#installation )
2018-03-27 13:14:31 -04:00
* [Upgrade ](#upgrade )
2018-01-29 05:23:38 -05:00
2018-01-12 12:07:41 -05:00
## Installation
2018-07-24 10:22:21 -04:00
Please don't install PeerTube for production on a device behind a low bandwidth connection (example: your ADSL link).
2021-05-01 09:43:28 -04:00
If you want information about the appropriate hardware to run PeerTube, please see the [FAQ ](https://joinpeertube.org/en_US/faq#should-i-have-a-big-server-to-run-peertube ).
2018-02-09 07:38:19 -05:00
2021-12-08 03:44:14 -05:00
### :hammer: Dependencies
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
Follow the steps of the [dependencies guide ](dependencies.md ).
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
### :construction_worker: PeerTube user
2018-01-12 12:07:41 -05:00
2018-01-23 03:00:23 -05:00
Create a `peertube` user with `/var/www/peertube` home:
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-23 03:00:23 -05:00
$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
2018-01-23 02:53:15 -05:00
```
Set its password:
2021-12-08 03:44:14 -05:00
```bash
2018-01-15 11:56:58 -05:00
$ sudo passwd peertube
2018-01-12 12:07:41 -05:00
```
2018-03-27 13:14:31 -04:00
**On FreeBSD**
2021-12-08 03:44:14 -05:00
```bash
2018-03-27 13:14:31 -04:00
$ 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.
2021-12-08 03:44:14 -05:00
### :card_file_box: Database
2018-01-12 12:07:41 -05:00
2018-01-23 02:53:15 -05:00
Create the production database and a peertube user inside PostgreSQL:
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2021-05-25 05:15:18 -04:00
$ cd /var/www/peertube
2018-01-15 11:56:58 -05:00
$ sudo -u postgres createuser -P peertube
2021-03-01 03:18:08 -05:00
```
2021-03-04 06:24:23 -05:00
Here you should enter a password for PostgreSQL `peertube` user, that should be copied in `production.yaml` file.
Don't just hit enter else it will be empty.
2021-03-01 03:18:08 -05:00
2021-12-08 03:44:14 -05:00
```bash
2020-01-29 05:48:19 -05:00
$ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
2018-01-12 12:07:41 -05:00
```
2018-07-19 10:17:54 -04:00
Then enable extensions PeerTube needs:
2021-12-08 03:44:14 -05:00
```bash
2018-07-19 10:17:54 -04:00
$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
```
2021-12-08 03:44:14 -05:00
### :page_facing_up: Prepare PeerTube directory
2018-01-12 12:07:41 -05:00
2018-01-23 02:53:15 -05:00
Fetch the latest tagged version of Peertube
2021-12-08 03:44:14 -05:00
```bash
2018-01-23 02:53:15 -05:00
$ 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"
```
2018-01-23 03:00:23 -05:00
2018-01-23 02:53:15 -05:00
Open the peertube directory, create a few required directories
2021-12-08 03:44:14 -05:00
```bash
2021-01-11 04:09:24 -05:00
$ cd /var/www/peertube
$ sudo -u peertube mkdir config storage versions
2021-04-27 03:36:00 -04:00
$ sudo -u peertube chmod 750 config/
2018-01-23 02:53:15 -05:00
```
2018-01-23 03:00:23 -05:00
2018-01-23 02:53:15 -05:00
Download the latest version of the Peertube client, unzip it and remove the zip
2021-12-08 03:44:14 -05:00
```bash
2021-01-11 04:09:24 -05:00
$ cd /var/www/peertube/versions
2018-01-25 02:13:19 -05:00
$ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
2021-03-03 06:23:23 -05:00
$ sudo -u peertube unzip -q peertube-${VERSION}.zip & & sudo -u peertube rm peertube-${VERSION}.zip
2018-01-23 02:53:15 -05:00
```
2018-01-23 03:00:23 -05:00
2018-05-26 21:25:10 -04:00
Install Peertube:
2021-12-08 03:44:14 -05:00
```bash
2021-01-11 04:09:24 -05:00
$ cd /var/www/peertube
$ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
2018-02-01 02:55:17 -05:00
$ cd ./peertube-latest & & sudo -H -u peertube yarn install --production --pure-lockfile
2018-01-12 12:07:41 -05:00
```
2021-12-08 03:44:14 -05:00
### :wrench: PeerTube configuration
2018-01-12 12:07:41 -05:00
2021-01-04 04:29:08 -05:00
Copy the default configuration file that contains the default configuration provided by PeerTube.
You **must not** update this file.
2021-12-08 03:44:14 -05:00
```bash
2021-01-11 04:09:24 -05:00
$ cd /var/www/peertube
$ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
2021-01-04 04:29:08 -05:00
```
Now copy the production example configuration:
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2021-01-11 04:09:24 -05:00
$ cd /var/www/peertube
$ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
2018-01-12 12:07:41 -05:00
```
Then edit the `config/production.yaml` file according to your webserver
2021-01-11 04:09:24 -05:00
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` .
2018-01-12 12:07:41 -05:00
2021-01-05 05:01:12 -05:00
**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.
2018-03-21 05:57:45 -04:00
2021-12-08 03:44:14 -05:00
### :truck: Webserver
2018-01-12 12:07:41 -05:00
2018-02-14 05:11:49 -05:00
We only provide official configuration files for Nginx.
2018-01-12 12:07:41 -05:00
Copy the nginx configuration template:
2021-12-08 03:44:14 -05:00
```bash
2018-01-23 03:00:23 -05:00
$ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
2018-01-12 12:07:41 -05:00
```
2020-08-14 08:59:15 -04:00
Then set the domain for the webserver configuration file.
Replace `[peertube-domain]` with the domain for the peertube server.
2019-12-30 04:39:59 -05:00
2021-12-08 03:44:14 -05:00
```bash
2020-03-02 18:29:52 -05:00
$ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
2021-01-07 05:11:57 -05:00
$ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
2019-12-30 04:39:59 -05:00
```
2018-01-18 11:44:13 -05:00
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).
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-12 12:07:41 -05:00
$ sudo vim /etc/nginx/sites-available/peertube
```
2018-02-16 05:04:12 -05:00
Activate the configuration file:
2021-12-08 03:44:14 -05:00
```bash
2018-02-16 05:04:12 -05:00
$ 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/ ):
2021-12-08 03:44:14 -05:00
```bash
2018-02-16 05:04:12 -05:00
$ sudo systemctl stop nginx
2021-02-04 10:50:35 -05:00
$ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
2018-03-01 10:12:00 -05:00
$ sudo systemctl reload nginx
2018-02-14 05:11:49 -05:00
```
2018-02-16 05:04:12 -05:00
Now you have the certificates you can reload nginx:
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-12 12:07:41 -05:00
$ sudo systemctl reload nginx
```
2021-01-11 04:09:24 -05:00
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:
2021-12-08 03:44:14 -05:00
```bash
2021-01-11 04:09:24 -05:00
$ # Replace authenticator = standalone by authenticator = webroot
2021-02-04 10:45:00 -05:00
$ # Add webroot_path = /var/www/certbot
2021-01-11 04:09:24 -05:00
$ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
```
2018-03-27 13:14:31 -04:00
**FreeBSD**
On FreeBSD you can use [Dehydrated ](https://dehydrated.io/ ) `security/dehydrated` for [Let's Encrypt ](https://letsencrypt.org/ )
2021-12-08 03:44:14 -05:00
```bash
2018-03-27 13:14:31 -04:00
$ sudo pkg install dehydrated
```
2021-12-08 03:44:14 -05:00
### :alembic: TCP/IP Tuning
2018-08-28 03:29:29 -04:00
**On Linux**
2021-12-08 03:44:14 -05:00
```bash
2018-08-28 03:29:29 -04:00
$ 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.
2021-12-08 03:44:14 -05:00
### :bricks: systemd
2018-01-12 12:07:41 -05:00
2018-03-20 03:28:20 -04:00
If your OS uses systemd, copy the configuration template:
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-23 03:00:23 -05:00
$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
2018-01-12 12:07:41 -05:00
```
2020-08-26 02:31:20 -04:00
Check the service file (PeerTube paths and security directives):
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-15 11:56:58 -05:00
$ sudo vim /etc/systemd/system/peertube.service
2018-01-12 12:07:41 -05:00
```
Tell systemd to reload its config:
2021-12-08 03:44:14 -05:00
```bash
2018-01-15 11:56:58 -05:00
$ sudo systemctl daemon-reload
2018-01-12 12:07:41 -05:00
```
2018-01-15 05:10:46 -05:00
If you want to start PeerTube on boot:
2021-12-08 03:44:14 -05:00
```bash
2018-01-17 05:47:45 -05:00
$ sudo systemctl enable peertube
2018-01-15 05:10:46 -05:00
```
2018-03-20 03:28:20 -04:00
Run:
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-15 11:56:58 -05:00
$ sudo systemctl start peertube
$ sudo journalctl -feu peertube
2018-01-12 12:07:41 -05:00
```
2018-08-21 04:48:57 -04:00
**FreeBSD**
On FreeBSD, copy the startup script and update rc.conf:
2018-03-19 17:48:15 -04:00
2021-12-08 03:44:14 -05:00
```bash
2018-11-21 04:18:44 -05:00
$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
$ sudo sysrc peertube_enable="YES"
2018-03-19 17:48:15 -04:00
```
2018-03-20 03:28:20 -04:00
Run:
2018-03-19 17:48:15 -04:00
2021-12-08 03:44:14 -05:00
```bash
2018-03-19 17:48:15 -04:00
$ sudo service peertube start
```
2021-12-08 03:44:14 -05:00
### :bricks: OpenRC
2019-08-13 03:22:54 -04:00
If your OS uses OpenRC, copy the service script:
2021-12-08 03:44:14 -05:00
```bash
2019-08-13 03:22:54 -04:00
$ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
```
If you want to start PeerTube on boot:
2021-12-08 03:44:14 -05:00
```bash
2019-08-13 03:22:54 -04:00
$ sudo rc-update add peertube default
```
Run and print last logs:
2021-12-08 03:44:14 -05:00
```bash
2019-08-13 03:22:54 -04:00
$ sudo /etc/init.d/peertube start
$ tail -f /var/log/peertube/peertube.log
```
2021-12-08 03:44:14 -05:00
### :technologist: Administrator
2018-01-12 12:07:41 -05:00
2021-01-11 04:09:24 -05:00
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:
2018-01-12 12:07:41 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-23 03:00:23 -05:00
$ cd /var/www/peertube/peertube-latest & & NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
2018-01-12 12:07:41 -05:00
```
2019-05-14 18:18:48 -04:00
Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD` ,
to your own administrator password, although it must be 6 characters or more.
2021-12-08 03:44:14 -05:00
### :tada: What now?
2018-04-06 04:36:21 -04:00
Now your instance is up you can:
2020-08-14 08:59:15 -04:00
2020-09-21 08:13:12 -04:00
* Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
2019-02-21 09:02:35 -05:00
* Check [available CLI tools ](/support/doc/tools.md )
2018-03-15 09:31:08 -04:00
2018-01-12 12:07:41 -05:00
## Upgrade
2018-07-19 10:17:54 -04:00
### PeerTube instance
2018-06-14 03:42:03 -04:00
**Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
2021-01-07 05:15:16 -05:00
#### Auto
2018-02-14 05:03:39 -05:00
2018-03-29 08:27:55 -04:00
The password it asks is PeerTube's database user password.
2021-12-08 03:44:14 -05:00
```bash
2018-06-07 09:03:42 -04:00
$ cd /var/www/peertube/peertube-latest/scripts & & sudo -H -u peertube ./upgrade.sh
2021-09-09 05:04:57 -04:00
$ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd
2018-02-14 05:03:39 -05:00
```
2018-02-14 05:09:02 -05:00
#### Manually
2018-01-26 04:50:05 -05:00
Make a SQL backup
2018-01-19 04:30:35 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-19 04:30:35 -05:00
$ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" & & \
2018-01-23 03:00:23 -05:00
cd /var/www/peertube & & sudo -u peertube mkdir -p backup & & \
2018-07-29 13:23:30 -04:00
sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
2018-01-19 04:30:35 -05:00
```
2018-01-26 04:50:05 -05:00
Fetch the latest tagged version of Peertube:
2018-01-19 07:58:13 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-26 04:50:05 -05:00
$ 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"
2018-01-19 07:58:13 -05:00
```
2018-01-26 04:50:05 -05:00
Download the new version and unzip it:
2018-01-19 04:30:35 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-26 04:50:05 -05:00
$ cd /var/www/peertube/versions & & \
2018-01-17 04:32:03 -05:00
sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" & & \
2018-01-26 04:50:05 -05:00
sudo -u peertube unzip -o peertube-${VERSION}.zip & & \
sudo -u peertube rm peertube-${VERSION}.zip
```
2018-01-29 05:58:07 -05:00
Install node dependencies:
2018-01-26 04:50:05 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-29 05:58:07 -05:00
$ cd /var/www/peertube/versions/peertube-${VERSION} & & \
2018-06-07 09:03:42 -04:00
sudo -H -u peertube yarn install --production --pure-lockfile
2018-01-26 04:50:05 -05:00
```
2018-01-29 05:58:07 -05:00
Copy new configuration defaults values and update your configuration file:
2018-01-26 04:50:05 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-29 05:58:07 -05:00
$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
2018-02-14 05:09:02 -05:00
$ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
2018-01-26 04:50:05 -05:00
```
2018-01-29 05:58:07 -05:00
Change the link to point to the latest version:
2018-01-26 04:50:05 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-29 05:58:07 -05:00
$ cd /var/www/peertube & & \
2018-02-19 03:42:43 -05:00
sudo unlink ./peertube-latest & & \
2018-01-29 05:58:07 -05:00
sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
2018-01-26 04:50:05 -05:00
```
2018-06-14 03:42:03 -04:00
### nginx
Check changes in nginx configuration:
2021-12-08 03:44:14 -05:00
```bash
2018-06-14 03:42:03 -04:00
$ 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:
2021-12-08 03:44:14 -05:00
```bash
2018-06-14 03:42:03 -04:00
$ 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:
2021-12-08 03:44:14 -05:00
```bash
2018-06-14 03:42:03 -04:00
$ sudo systemctl reload nginx
```
If you changed your systemd configuration:
2018-01-29 05:58:07 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-06-14 03:42:03 -04:00
$ sudo systemctl daemon-reload
```
Restart PeerTube and check the logs:
2021-12-08 03:44:14 -05:00
```bash
2018-06-14 03:42:03 -04:00
$ sudo systemctl restart peertube & & sudo journalctl -fu peertube
2018-01-26 04:50:05 -05:00
```
2018-03-27 13:14:31 -04:00
### Things went wrong?
2018-01-19 04:30:35 -05:00
2018-01-26 04:50:05 -05:00
Change `peertube-latest` destination to the previous version and restore your SQL backup:
2018-01-19 04:30:35 -05:00
2021-12-08 03:44:14 -05:00
```bash
2018-01-19 04:30:35 -05:00
$ OLD_VERSION="v0.42.42" & & SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" & & \
2018-07-29 13:23:30 -04:00
cd /var/www/peertube & & sudo -u peertube unlink ./peertube-latest & & \
2018-01-19 04:30:35 -05:00
sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest & & \
2018-07-29 13:23:30 -04:00
sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" & & \
2018-01-19 04:30:35 -05:00
sudo systemctl restart peertube
```