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).
13 **Follow the steps of the [dependencies guide](dependencies.md).**
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.
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 ### Prepare PeerTube directory
61 Fetch the latest tagged version of Peertube
63 $ 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"
66 Open the peertube directory, create a few required directories
68 $ cd /var/www/peertube
69 $ sudo -u peertube mkdir config storage versions
70 $ sudo -u peertube chmod 750 config/
73 Download the latest version of the Peertube client, unzip it and remove the zip
75 $ cd /var/www/peertube/versions
76 $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
77 $ sudo -u peertube unzip -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
82 $ cd /var/www/peertube
83 $ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
84 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
87 ### PeerTube configuration
89 Copy the default configuration file that contains the default configuration provided by PeerTube.
90 You **must not** update this file.
93 $ cd /var/www/peertube
94 $ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
97 Now copy the production example configuration:
100 $ cd /var/www/peertube
101 $ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
104 Then edit the `config/production.yaml` file according to your webserver
105 and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
106 Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
108 **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.
112 We only provide official configuration files for Nginx.
114 Copy the nginx configuration template:
117 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
120 Then set the domain for the webserver configuration file.
121 Replace `[peertube-domain]` with the domain for the peertube server.
124 $ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
125 $ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
128 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
129 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
132 $ sudo vim /etc/nginx/sites-available/peertube
135 Activate the configuration file:
138 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
141 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
144 $ sudo systemctl stop nginx
145 $ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
146 $ sudo systemctl reload nginx
149 Now you have the certificates you can reload nginx:
152 $ sudo systemctl reload nginx
155 Certbot should have installed a cron to automatically renew your certificate.
156 Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:
159 $ # Replace authenticator = standalone by authenticator = webroot
160 $ # Add webroot_path = /var/www/certbot
161 $ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
165 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
168 $ sudo pkg install dehydrated
176 $ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
177 $ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
180 Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
181 scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
182 links as we often encounter in a video server.
186 If your OS uses systemd, copy the configuration template:
189 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
192 Check the service file (PeerTube paths and security directives):
195 $ sudo vim /etc/systemd/system/peertube.service
199 Tell systemd to reload its config:
202 $ sudo systemctl daemon-reload
205 If you want to start PeerTube on boot:
208 $ sudo systemctl enable peertube
214 $ sudo systemctl start peertube
215 $ sudo journalctl -feu peertube
219 On FreeBSD, copy the startup script and update rc.conf:
222 $ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
223 $ sudo sysrc peertube_enable="YES"
229 $ sudo service peertube start
234 If your OS uses OpenRC, copy the service script:
237 $ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
240 If you want to start PeerTube on boot:
243 $ sudo rc-update add peertube default
246 Run and print last logs:
249 $ sudo /etc/init.d/peertube start
250 $ tail -f /var/log/peertube/peertube.log
255 The administrator password is automatically generated and can be found in the PeerTube
256 logs (path defined in `production.yaml`). You can also set another password with:
259 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
262 Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
263 to your own administrator password, although it must be 6 characters or more.
267 Now your instance is up you can:
269 * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
270 * Check [available CLI tools](/support/doc/tools.md)
274 ### PeerTube instance
276 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
280 The password it asks is PeerTube's database user password.
283 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
284 $ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd
292 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
293 cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
294 sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
297 Fetch the latest tagged version of Peertube:
300 $ 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"
303 Download the new version and unzip it:
306 $ cd /var/www/peertube/versions && \
307 sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
308 sudo -u peertube unzip -o peertube-${VERSION}.zip && \
309 sudo -u peertube rm peertube-${VERSION}.zip
312 Install node dependencies:
315 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
316 sudo -H -u peertube yarn install --production --pure-lockfile
319 Copy new configuration defaults values and update your configuration file:
322 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
323 $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
326 Change the link to point to the latest version:
329 $ cd /var/www/peertube && \
330 sudo unlink ./peertube-latest && \
331 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
336 Check changes in nginx configuration:
339 $ cd /var/www/peertube/versions
340 $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
345 Check changes in systemd configuration:
348 $ cd /var/www/peertube/versions
349 $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
354 If you changed your nginx configuration:
357 $ sudo systemctl reload nginx
360 If you changed your systemd configuration:
363 $ sudo systemctl daemon-reload
366 Restart PeerTube and check the logs:
369 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
372 ### Things went wrong?
374 Change `peertube-latest` destination to the previous version and restore your SQL backup:
377 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
378 cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
379 sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
380 sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
381 sudo systemctl restart peertube