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
62 $ sudo -u peertube mkdir config storage versions
65 Download the latest version of the Peertube client, unzip it and remove the zip
67 $ cd /var/www/peertube/versions
68 $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
69 $ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
74 $ cd /var/www/peertube
75 $ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
76 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
79 ### PeerTube configuration
81 Copy the default configuration file that contains the default configuration provided by PeerTube.
82 You **must not** update this file.
85 $ cd /var/www/peertube
86 $ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
89 Now copy the production example configuration:
92 $ cd /var/www/peertube
93 $ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
96 Then edit the `config/production.yaml` file according to your webserver
97 and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
98 Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
100 **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.
104 We only provide official configuration files for Nginx.
106 Copy the nginx configuration template:
109 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
112 Then set the domain for the webserver configuration file.
113 Replace `[peertube-domain]` with the domain for the peertube server.
116 $ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
117 $ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
120 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
121 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
124 $ sudo vim /etc/nginx/sites-available/peertube
127 Activate the configuration file:
130 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
133 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
136 $ sudo systemctl stop nginx
137 $ sudo certbot certonly --standalone --post-hook "systemctl start nginx"
138 $ sudo systemctl reload nginx
141 Now you have the certificates you can reload nginx:
144 $ sudo systemctl reload nginx
147 Certbot should have installed a cron to automatically renew your certificate.
148 Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:
151 $ # Replace authenticator = standalone by authenticator = webroot
152 $ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
156 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
159 $ sudo pkg install dehydrated
164 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.
169 $ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
170 $ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
173 Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
174 scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
175 links as we often encounter in a video server.
179 If your OS uses systemd, copy the configuration template:
182 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
185 Check the service file (PeerTube paths and security directives):
188 $ sudo vim /etc/systemd/system/peertube.service
192 Tell systemd to reload its config:
195 $ sudo systemctl daemon-reload
198 If you want to start PeerTube on boot:
201 $ sudo systemctl enable peertube
207 $ sudo systemctl start peertube
208 $ sudo journalctl -feu peertube
212 On FreeBSD, copy the startup script and update rc.conf:
215 $ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
216 $ sudo sysrc peertube_enable="YES"
222 $ sudo service peertube start
227 If your OS uses OpenRC, copy the service script:
230 $ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
233 If you want to start PeerTube on boot:
236 $ sudo rc-update add peertube default
239 Run and print last logs:
242 $ sudo /etc/init.d/peertube start
243 $ tail -f /var/log/peertube/peertube.log
248 The administrator password is automatically generated and can be found in the PeerTube
249 logs (path defined in `production.yaml`). You can also set another password with:
252 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
255 Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
256 to your own administrator password, although it must be 6 characters or more.
260 Now your instance is up you can:
262 * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
263 * Check [available CLI tools](/support/doc/tools.md)
267 ### PeerTube instance
269 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
273 The password it asks is PeerTube's database user password.
276 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
284 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
285 cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
286 sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
289 Fetch the latest tagged version of Peertube:
292 $ 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"
295 Download the new version and unzip it:
298 $ cd /var/www/peertube/versions && \
299 sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
300 sudo -u peertube unzip -o peertube-${VERSION}.zip && \
301 sudo -u peertube rm peertube-${VERSION}.zip
304 Install node dependencies:
307 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
308 sudo -H -u peertube yarn install --production --pure-lockfile
311 Copy new configuration defaults values and update your configuration file:
314 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
315 $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
318 Change the link to point to the latest version:
321 $ cd /var/www/peertube && \
322 sudo unlink ./peertube-latest && \
323 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
328 Check changes in nginx configuration:
331 $ cd /var/www/peertube/versions
332 $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
337 Check changes in systemd configuration:
340 $ cd /var/www/peertube/versions
341 $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
346 If you changed your nginx configuration:
349 $ sudo systemctl reload nginx
352 If you changed your systemd configuration:
355 $ sudo systemctl daemon-reload
358 Restart PeerTube and check the logs:
361 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
364 ### Things went wrong?
366 Change `peertube-latest` destination to the previous version and restore your SQL backup:
369 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
370 cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
371 sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
372 sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
373 sudo systemctl restart peertube