3 * [Installation](#installation)
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://joinpeertube.org/en_US/faq#should-i-have-a-big-server-to-run-peertube).
11 ### :hammer: Dependencies
13 Follow the steps of the [dependencies guide](dependencies.md).
15 ### :construction_worker: PeerTube user
17 Create a `peertube` user with `/var/www/peertube` home:
20 $ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
25 $ sudo passwd peertube
28 Ensure the peertube root directory is traversable by nginx:
31 $ ls -ld /var/www/peertube # Should be drwxr-xr-x
37 $ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
38 $ sudo passwd peertube
40 or use `adduser` to create it interactively.
42 ### :card_file_box: Database
44 Create the production database and a peertube user inside PostgreSQL:
47 $ cd /var/www/peertube
48 $ sudo -u postgres createuser -P peertube
51 Here you should enter a password for PostgreSQL `peertube` user, that should be copied in `production.yaml` file.
52 Don't just hit enter else it will be empty.
55 $ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
58 Then enable extensions PeerTube needs:
61 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
62 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
65 ### :page_facing_up: Prepare PeerTube directory
67 Fetch the latest tagged version of Peertube:
70 $ 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"
74 Open the peertube directory, create a few required directories:
77 $ cd /var/www/peertube
78 $ sudo -u peertube mkdir config storage versions
79 $ sudo -u peertube chmod 750 config/
83 Download the latest version of the Peertube client, unzip it and remove the zip:
86 $ cd /var/www/peertube/versions
87 $ # Releases are also available on https://builds.joinpeertube.org/release
88 $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
89 $ sudo -u peertube unzip -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
96 $ cd /var/www/peertube
97 $ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
98 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
101 ### :wrench: PeerTube configuration
103 Copy the default configuration file that contains the default configuration provided by PeerTube.
104 You **must not** update this file.
107 $ cd /var/www/peertube
108 $ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
111 Now copy the production example configuration:
114 $ cd /var/www/peertube
115 $ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
118 Then edit the `config/production.yaml` file according to your webserver
119 and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
120 Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
122 **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.
124 ### :truck: Webserver
126 We only provide official configuration files for Nginx.
128 Copy the nginx configuration template:
131 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
134 Then set the domain for the webserver configuration file.
135 Replace `[peertube-domain]` with the domain for the peertube server.
138 $ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
139 $ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
142 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
143 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
146 $ sudo vim /etc/nginx/sites-available/peertube
149 Activate the configuration file:
152 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
155 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
158 $ sudo systemctl stop nginx
159 $ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
160 $ sudo systemctl reload nginx
163 Now you have the certificates you can reload nginx:
166 $ sudo systemctl reload nginx
169 Certbot should have installed a cron to automatically renew your certificate.
170 Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:
173 $ # Replace authenticator = standalone by authenticator = webroot
174 $ # Add webroot_path = /var/www/certbot
175 $ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
179 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
182 $ sudo pkg install dehydrated
185 ### :alembic: TCP/IP Tuning
190 $ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
191 $ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
194 Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
195 scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
196 links as we often encounter in a video server.
200 If your OS uses systemd, copy the configuration template:
203 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
206 Check the service file (PeerTube paths and security directives):
209 $ sudo vim /etc/systemd/system/peertube.service
213 Tell systemd to reload its config:
216 $ sudo systemctl daemon-reload
219 If you want to start PeerTube on boot:
222 $ sudo systemctl enable peertube
228 $ sudo systemctl start peertube
229 $ sudo journalctl -feu peertube
233 On FreeBSD, copy the startup script and update rc.conf:
236 $ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
237 $ sudo sysrc peertube_enable="YES"
243 $ sudo service peertube start
248 If your OS uses OpenRC, copy the service script:
251 $ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
254 If you want to start PeerTube on boot:
257 $ sudo rc-update add peertube default
260 Run and print last logs:
263 $ sudo /etc/init.d/peertube start
264 $ tail -f /var/log/peertube/peertube.log
267 ### :technologist: Administrator
269 The administrator username is `root` and the password is automatically generated. It can be found in PeerTube
270 logs (path defined in `production.yaml`). You can also set another password with:
273 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
276 Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
277 to your own administrator password, although it must be 6 characters or more.
281 Now your instance is up you can:
283 * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
284 * Check [available CLI tools](/support/doc/tools.md)
288 ### PeerTube instance
290 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
294 The password it asks is PeerTube's database user password.
297 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
298 $ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd
306 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
307 cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
308 sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
311 Fetch the latest tagged version of Peertube:
314 $ 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"
317 Download the new version and unzip it:
320 $ cd /var/www/peertube/versions && \
321 sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
322 sudo -u peertube unzip -o peertube-${VERSION}.zip && \
323 sudo -u peertube rm peertube-${VERSION}.zip
326 Install node dependencies:
329 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
330 sudo -H -u peertube yarn install --production --pure-lockfile
333 Copy new configuration defaults values and update your configuration file:
336 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
337 $ diff -u /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
340 Change the link to point to the latest version:
343 $ cd /var/www/peertube && \
344 sudo unlink ./peertube-latest && \
345 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
350 You can check for configuration changes, and report them in your `config/production.yaml` file:
353 $ cd /var/www/peertube/versions
354 $ diff -u "$(ls --sort=t | head -2 | tail -1)/config/production.yaml.example" "$(ls --sort=t | head -1)/config/production.yaml.example"
359 Check changes in nginx configuration:
362 $ cd /var/www/peertube/versions
363 $ diff -u "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
368 Check changes in systemd configuration:
371 $ cd /var/www/peertube/versions
372 $ diff -u "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
377 If you changed your nginx configuration:
380 $ sudo systemctl reload nginx
383 If you changed your systemd configuration:
386 $ sudo systemctl daemon-reload
389 Restart PeerTube and check the logs:
392 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
395 ### Things went wrong?
397 Change `peertube-latest` destination to the previous version and restore your SQL backup:
400 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
401 cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
402 sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
403 sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
404 sudo systemctl restart peertube