mirror of https://github.com/Chocobozzz/PeerTube
Improve production guide
Add syntax highlighting Add emoji on section titles to better differenciate each sectionpull/4624/head
Chocobozzz
parent
2d4822e3af
commit
a23f6c94ed
|
|
@ -8,36 +8,36 @@
|
|||
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://joinpeertube.org/en_US/faq#should-i-have-a-big-server-to-run-peertube).
|
||||
|
||||
### Dependencies
|
||||
### :hammer: Dependencies
|
||||
|
||||
**Follow the steps of the [dependencies guide](dependencies.md).**
|
||||
Follow the steps of the [dependencies guide](dependencies.md).
|
||||
|
||||
### PeerTube user
|
||||
### :construction_worker: PeerTube user
|
||||
|
||||
Create a `peertube` user with `/var/www/peertube` home:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
|
||||
```
|
||||
|
||||
Set its password:
|
||||
```
|
||||
```bash
|
||||
$ sudo passwd peertube
|
||||
```
|
||||
|
||||
**On FreeBSD**
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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
|
||||
### :card_file_box: Database
|
||||
|
||||
Create the production database and a peertube user inside PostgreSQL:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd /var/www/peertube
|
||||
$ sudo -u postgres createuser -P peertube
|
||||
```
|
||||
|
|
@ -45,58 +45,58 @@ $ sudo -u postgres createuser -P peertube
|
|||
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.
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
|
||||
```
|
||||
|
||||
Then enable extensions PeerTube needs:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
|
||||
$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
|
||||
```
|
||||
|
||||
### Prepare PeerTube directory
|
||||
### :page_facing_up: Prepare PeerTube directory
|
||||
|
||||
Fetch the latest tagged version of Peertube
|
||||
```
|
||||
```bash
|
||||
$ 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
|
||||
```
|
||||
```bash
|
||||
$ cd /var/www/peertube
|
||||
$ sudo -u peertube mkdir config storage versions
|
||||
$ sudo -u peertube chmod 750 config/
|
||||
```
|
||||
|
||||
Download the latest version of the Peertube client, unzip it and remove the zip
|
||||
```
|
||||
```bash
|
||||
$ 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 -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
|
||||
```
|
||||
|
||||
Install Peertube:
|
||||
```
|
||||
```bash
|
||||
$ 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
|
||||
### :wrench: PeerTube configuration
|
||||
|
||||
Copy the default configuration file that contains the default configuration provided by PeerTube.
|
||||
You **must not** update this file.
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd /var/www/peertube
|
||||
$ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
|
||||
```
|
||||
|
||||
Now copy the production example configuration:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd /var/www/peertube
|
||||
$ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
|
||||
```
|
||||
|
|
@ -107,20 +107,20 @@ Keys defined in `config/production.yaml` will override keys defined in `config/d
|
|||
|
||||
**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
|
||||
### :truck: Webserver
|
||||
|
||||
We only provide official configuration files for Nginx.
|
||||
|
||||
Copy the nginx configuration template:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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.
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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
|
||||
```
|
||||
|
|
@ -128,19 +128,19 @@ $ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/p
|
|||
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).
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo vim /etc/nginx/sites-available/peertube
|
||||
```
|
||||
|
||||
Activate the configuration file:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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/):
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo systemctl stop nginx
|
||||
$ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
|
||||
$ sudo systemctl reload nginx
|
||||
|
|
@ -148,14 +148,14 @@ $ sudo systemctl reload nginx
|
|||
|
||||
Now you have the certificates you can reload nginx:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ # Replace authenticator = standalone by authenticator = webroot
|
||||
$ # Add webroot_path = /var/www/certbot
|
||||
$ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
|
||||
|
|
@ -164,15 +164,15 @@ $ 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/)
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo pkg install dehydrated
|
||||
```
|
||||
|
||||
### TCP/IP Tuning
|
||||
### :alembic: TCP/IP Tuning
|
||||
|
||||
**On Linux**
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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
|
||||
```
|
||||
|
|
@ -181,36 +181,36 @@ Your distro may enable this by default, but at least Debian 9 does not, and the
|
|||
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
|
||||
### :bricks: systemd
|
||||
|
||||
If your OS uses systemd, copy the configuration template:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
|
||||
```
|
||||
|
||||
Check the service file (PeerTube paths and security directives):
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo vim /etc/systemd/system/peertube.service
|
||||
```
|
||||
|
||||
|
||||
Tell systemd to reload its config:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo systemctl daemon-reload
|
||||
```
|
||||
|
||||
If you want to start PeerTube on boot:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo systemctl enable peertube
|
||||
```
|
||||
|
||||
Run:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo systemctl start peertube
|
||||
$ sudo journalctl -feu peertube
|
||||
```
|
||||
|
|
@ -218,51 +218,51 @@ $ sudo journalctl -feu peertube
|
|||
**FreeBSD**
|
||||
On FreeBSD, copy the startup script and update rc.conf:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
|
||||
$ sudo sysrc peertube_enable="YES"
|
||||
```
|
||||
|
||||
Run:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo service peertube start
|
||||
```
|
||||
|
||||
### OpenRC
|
||||
### :bricks: OpenRC
|
||||
|
||||
If your OS uses OpenRC, copy the service script:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
|
||||
```
|
||||
|
||||
If you want to start PeerTube on boot:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo rc-update add peertube default
|
||||
```
|
||||
|
||||
Run and print last logs:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo /etc/init.d/peertube start
|
||||
$ tail -f /var/log/peertube/peertube.log
|
||||
```
|
||||
|
||||
### Administrator
|
||||
### :technologist: 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:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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?
|
||||
### :tada: What now?
|
||||
|
||||
Now your instance is up you can:
|
||||
|
||||
|
|
@ -279,7 +279,7 @@ Now your instance is up you can:
|
|||
|
||||
The password it asks is PeerTube's database user password.
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
|
||||
$ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd
|
||||
```
|
||||
|
|
@ -288,7 +288,7 @@ $ sudo systemctl restart peertube # Or use your OS command to restart PeerTube i
|
|||
|
||||
Make a SQL backup
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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
|
||||
|
|
@ -296,13 +296,13 @@ $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
|
|||
|
||||
Fetch the latest tagged version of Peertube:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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 && \
|
||||
|
|
@ -311,21 +311,21 @@ $ cd /var/www/peertube/versions && \
|
|||
|
||||
Install node dependencies:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd /var/www/peertube && \
|
||||
sudo unlink ./peertube-latest && \
|
||||
sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
|
||||
|
|
@ -335,7 +335,7 @@ $ cd /var/www/peertube && \
|
|||
|
||||
Check changes in nginx configuration:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd /var/www/peertube/versions
|
||||
$ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
|
||||
```
|
||||
|
|
@ -344,7 +344,7 @@ $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=
|
|||
|
||||
Check changes in systemd configuration:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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"
|
||||
```
|
||||
|
|
@ -353,19 +353,19 @@ $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(
|
|||
|
||||
If you changed your nginx configuration:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo systemctl reload nginx
|
||||
```
|
||||
|
||||
If you changed your systemd configuration:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo systemctl daemon-reload
|
||||
```
|
||||
|
||||
Restart PeerTube and check the logs:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ sudo systemctl restart peertube && sudo journalctl -fu peertube
|
||||
```
|
||||
|
||||
|
|
@ -373,7 +373,7 @@ $ sudo systemctl restart peertube && sudo journalctl -fu peertube
|
|||
|
||||
Change `peertube-latest` destination to the previous version and restore your SQL backup:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ 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 && \
|
||||
|
|
|
|||
Loading…
Reference in New Issue