# Production guide
* [Installation](#installation)
- * [Upgrade](#upgrade)
+ * [Upgrade](#upgrade)
## Installation
-**Please don't install PeerTube for production on a small device behind a low bandwidth connection (example: a Raspberry PI behind your ADSL link) because it could slow down the fediverse.**
+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).
+**Follow the steps of the [dependencies guide](dependencies.md).**
### PeerTube user
$ 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 createdb -O peertube 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
$ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
```
-Install Peertube
+Install Peertube:
```
$ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
$ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
Then edit the `config/production.yaml` file according to your webserver
configuration.
+**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
+
### Webserver
We only provide official configuration files for Nginx.
$ sudo systemctl reload nginx
```
-### Systemd
+**FreeBSD**
+On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
+
+```
+$ sudo pkg install dehydrated
+```
+
+### systemd
-Copy the SystemD configuration template:
+If your OS uses systemd, copy the configuration template:
```
$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
$ sudo systemctl enable peertube
```
-### Run
+Run:
```
$ sudo systemctl start peertube
$ sudo journalctl -feu peertube
```
+### FreeBSD
+
+If you're using FreeBSD, copy the startup script and update rc.conf:
+
+```
+$ sudo cp /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
+$ sudo chmod +x /usr/local/etc/rc.d/peertube
+$ sudo echo peertube_enable="YES" >> /etc/rc.conf
+```
+
+Run:
+
+```
+$ sudo service peertube start
+```
+
### Administrator
The administrator password is automatically generated and can be found in the
$ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
```
+### What now?
+
+Now your instance is up you can:
+
+ * Subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin
+ * Add you instance to the public PeerTube instances index if you want to: https://instances.peertu.be/
+
## Upgrade
+### PeerTube instance
+
+**Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
+
#### Auto (minor versions only)
+The password it asks is PeerTube's database user password.
+
```
-$ cd /var/www/peertube/peertube-latest/scripts && sudo -u peertube ./upgrade.sh
-$ sudo systemctl restart peertube && sudo journalctl -fu peertube
+$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
```
#### Manually
```
$ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
- sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH"
+ 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:
```
$ cd /var/www/peertube/versions/peertube-${VERSION} && \
- sudo -u peertube yarn install --production --pure-lockfile
+ sudo -H -u peertube yarn install --production --pure-lockfile
```
Copy new configuration defaults values and update your configuration file:
sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
```
+### nginx
+
+Check changes in nginx configuration:
-Restart PeerTube:
```
-$ sudo systemctl restart peertube
+$ 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?
+### 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 && unlink ./peertube-latest && \
+ cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
- pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH"
+ sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
sudo systemctl restart peertube
```