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
31 $ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
32 $ sudo passwd peertube
34 or use `adduser` to create it interactively.
36 ### :card_file_box: Database
38 Create the production database and a peertube user inside PostgreSQL:
41 $ cd /var/www/peertube
42 $ sudo -u postgres createuser -P peertube
45 Here you should enter a password for PostgreSQL `peertube` user, that should be copied in `production.yaml` file.
46 Don't just hit enter else it will be empty.
49 $ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
52 Then enable extensions PeerTube needs:
55 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
56 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
59 ### :page_facing_up: Prepare PeerTube directory
61 Fetch the latest tagged version of Peertube:
64 $ 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"
68 Open the peertube directory, create a few required directories:
71 $ cd /var/www/peertube
72 $ sudo -u peertube mkdir config storage versions
73 $ sudo -u peertube chmod 750 config/
77 Download the latest version of the Peertube client, unzip it and remove the zip:
80 $ cd /var/www/peertube/versions
81 $ # Releases are also available on https://builds.joinpeertube.org/release
82 $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
83 $ sudo -u peertube unzip -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
90 $ cd /var/www/peertube
91 $ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
92 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
95 ### :wrench: PeerTube configuration
97 Copy the default configuration file that contains the default configuration provided by PeerTube.
98 You **must not** update this file.
101 $ cd /var/www/peertube
102 $ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
105 Now copy the production example configuration:
108 $ cd /var/www/peertube
109 $ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
112 Then edit the `config/production.yaml` file according to your webserver
113 and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
114 Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
116 **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.
118 ### :truck: Webserver
120 We only provide official configuration files for Nginx.
122 Copy the nginx configuration template:
125 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
128 Then set the domain for the webserver configuration file.
129 Replace `[peertube-domain]` with the domain for the peertube server.
132 $ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
133 $ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
136 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
137 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
140 $ sudo vim /etc/nginx/sites-available/peertube
143 Activate the configuration file:
146 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
149 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
152 $ sudo systemctl stop nginx
153 $ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
154 $ sudo systemctl reload nginx
157 Now you have the certificates you can reload nginx:
160 $ sudo systemctl reload nginx
163 Certbot should have installed a cron to automatically renew your certificate.
164 Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:
167 $ # Replace authenticator = standalone by authenticator = webroot
168 $ # Add webroot_path = /var/www/certbot
169 $ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
173 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
176 $ sudo pkg install dehydrated
179 ### :alembic: TCP/IP Tuning
184 $ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
185 $ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
188 Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
189 scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
190 links as we often encounter in a video server.
194 If your OS uses systemd, copy the configuration template:
197 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
200 Check the service file (PeerTube paths and security directives):
203 $ sudo vim /etc/systemd/system/peertube.service
207 Tell systemd to reload its config:
210 $ sudo systemctl daemon-reload
213 If you want to start PeerTube on boot:
216 $ sudo systemctl enable peertube
222 $ sudo systemctl start peertube
223 $ sudo journalctl -feu peertube
227 On FreeBSD, copy the startup script and update rc.conf:
230 $ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
231 $ sudo sysrc peertube_enable="YES"
237 $ sudo service peertube start
242 If your OS uses OpenRC, copy the service script:
245 $ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
248 If you want to start PeerTube on boot:
251 $ sudo rc-update add peertube default
254 Run and print last logs:
257 $ sudo /etc/init.d/peertube start
258 $ tail -f /var/log/peertube/peertube.log
261 ### :technologist: Administrator
263 The administrator username is `root` and the password is automatically generated. It can be found in PeerTube
264 logs (path defined in `production.yaml`). You can also set another password with:
267 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
270 Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
271 to your own administrator password, although it must be 6 characters or more.
275 Now your instance is up you can:
277 * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
278 * Check [available CLI tools](/support/doc/tools.md)
282 ### PeerTube instance
284 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
288 The password it asks is PeerTube's database user password.
291 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
292 $ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd
300 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
301 cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
302 sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
305 Fetch the latest tagged version of Peertube:
308 $ 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"
311 Download the new version and unzip it:
314 $ cd /var/www/peertube/versions && \
315 sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
316 sudo -u peertube unzip -o peertube-${VERSION}.zip && \
317 sudo -u peertube rm peertube-${VERSION}.zip
320 Install node dependencies:
323 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
324 sudo -H -u peertube yarn install --production --pure-lockfile
327 Copy new configuration defaults values and update your configuration file:
330 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
331 $ diff -u /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
334 Change the link to point to the latest version:
337 $ cd /var/www/peertube && \
338 sudo unlink ./peertube-latest && \
339 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
344 Check changes in nginx configuration:
347 $ cd /var/www/peertube/versions
348 $ diff -u "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
353 Check changes in systemd configuration:
356 $ cd /var/www/peertube/versions
357 $ diff -u "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
362 If you changed your nginx configuration:
365 $ sudo systemctl reload nginx
368 If you changed your systemd configuration:
371 $ sudo systemctl daemon-reload
374 Restart PeerTube and check the logs:
377 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
380 ### Things went wrong?
382 Change `peertube-latest` destination to the previous version and restore your SQL backup:
385 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
386 cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
387 sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
388 sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
389 sudo systemctl restart peertube