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://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#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 $ sudo -u postgres createuser -P peertube
42 $ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
45 Then enable extensions PeerTube needs:
48 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
49 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
52 ### Prepare PeerTube directory
54 Fetch the latest tagged version of Peertube
56 $ 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"
59 Open the peertube directory, create a few required directories
61 $ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions
64 Download the latest version of the Peertube client, unzip it and remove the zip
66 $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
67 $ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
72 $ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
73 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
76 ### PeerTube configuration
78 Copy example configuration:
81 $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
84 Then edit the `config/production.yaml` file according to your webserver
87 **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
91 We only provide official configuration files for Nginx.
93 Copy the nginx configuration template:
96 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
99 Then set the domain for the webserver configuration file.
100 Replace `[peertube-domain]` with the domain for the peertube server.
103 $ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
104 $ sudo sed -i 's/${PEERTUBE_HOST}/localhost:9000/g' /etc/nginx/sites-available/peertube
107 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
108 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
111 $ sudo vim /etc/nginx/sites-available/peertube
114 Activate the configuration file:
117 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
120 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
123 $ sudo systemctl stop nginx
124 $ sudo certbot certonly --standalone --post-hook "systemctl start nginx"
125 $ sudo systemctl reload nginx
128 Remember your certificate will expire in 90 days, and thus needs renewal.
130 Now you have the certificates you can reload nginx:
133 $ sudo systemctl reload nginx
137 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
140 $ sudo pkg install dehydrated
145 A lot of your instance's raw performance is dependent on a properly tuned machine and more specifically, reverse-proxy. We provide support for Nginx and spent a lot of time putting sane defaults in it, but we strongly advise you to follow up with instructions in https://github.com/denji/nginx-tuning as needed.
150 $ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
151 $ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
154 Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
155 scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
156 links as we often encounter in a video server.
160 If your OS uses systemd, copy the configuration template:
163 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
166 Check the service file (PeerTube paths and security directives):
169 $ sudo vim /etc/systemd/system/peertube.service
173 Tell systemd to reload its config:
176 $ sudo systemctl daemon-reload
179 If you want to start PeerTube on boot:
182 $ sudo systemctl enable peertube
188 $ sudo systemctl start peertube
189 $ sudo journalctl -feu peertube
193 On FreeBSD, copy the startup script and update rc.conf:
196 $ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
197 $ sudo sysrc peertube_enable="YES"
203 $ sudo service peertube start
208 If your OS uses OpenRC, copy the service script:
211 $ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
214 If you want to start PeerTube on boot:
217 $ sudo rc-update add peertube default
220 Run and print last logs:
223 $ sudo /etc/init.d/peertube start
224 $ tail -f /var/log/peertube/peertube.log
229 The administrator password is automatically generated and can be found in the
230 logs. You can set another password with:
233 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
236 Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
237 to your own administrator password, although it must be 6 characters or more.
241 Now your instance is up you can:
243 * Subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin
244 * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
245 * Check [available CLI tools](/support/doc/tools.md)
249 ### PeerTube instance
251 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
253 #### Auto (minor versions only)
255 The password it asks is PeerTube's database user password.
258 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
266 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
267 cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
268 sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
271 Fetch the latest tagged version of Peertube:
274 $ 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"
277 Download the new version and unzip it:
280 $ cd /var/www/peertube/versions && \
281 sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
282 sudo -u peertube unzip -o peertube-${VERSION}.zip && \
283 sudo -u peertube rm peertube-${VERSION}.zip
286 Install node dependencies:
289 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
290 sudo -H -u peertube yarn install --production --pure-lockfile
293 Copy new configuration defaults values and update your configuration file:
296 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
297 $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
300 Change the link to point to the latest version:
303 $ cd /var/www/peertube && \
304 sudo unlink ./peertube-latest && \
305 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
310 Check changes in nginx configuration:
313 $ cd /var/www/peertube/versions
314 $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
319 Check changes in systemd configuration:
322 $ cd /var/www/peertube/versions
323 $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
328 If you changed your nginx configuration:
331 $ sudo systemctl reload nginx
334 If you changed your systemd configuration:
337 $ sudo systemctl daemon-reload
340 Restart PeerTube and check the logs:
343 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
346 ### Things went wrong?
348 Change `peertube-latest` destination to the previous version and restore your SQL backup:
351 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
352 cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
353 sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
354 sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
355 sudo systemctl restart peertube