]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - support/doc/production.md
Generate translations
[github/Chocobozzz/PeerTube.git] / support / doc / production.md
CommitLineData
63bfad7e
C
1# Production guide
2
4df6a1b8 3 * [Installation](#installation)
4c86a254 4 * [Upgrade](#upgrade)
4df6a1b8 5
63bfad7e
C
6## Installation
7
76dd3e89
C
8Please don't install PeerTube for production on a device behind a low bandwidth connection (example: your ADSL link).
9If 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).
1185c246 10
63bfad7e
C
11### Dependencies
12
b4d1af3d 13**Follow the steps of the [dependencies guide](dependencies.md).**
63bfad7e
C
14
15### PeerTube user
16
59c48d49 17Create a `peertube` user with `/var/www/peertube` home:
63bfad7e 18
afe81767 19```
59c48d49 20$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
e5203ffa
TC
21```
22
23Set its password:
24```
d2000ca6 25$ sudo passwd peertube
63bfad7e
C
26```
27
4c86a254
GN
28**On FreeBSD**
29
30```
31$ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
32$ sudo passwd peertube
33```
34or use `adduser` to create it interactively.
35
63bfad7e
C
36### Database
37
e5203ffa 38Create the production database and a peertube user inside PostgreSQL:
63bfad7e 39
afe81767 40```
d2000ca6 41$ sudo -u postgres createuser -P peertube
0539dba8 42$ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
63bfad7e
C
43```
44
57c36b27
C
45Then enable extensions PeerTube needs:
46
47```
48$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
49$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
50```
51
d2000ca6 52### Prepare PeerTube directory
63bfad7e 53
e5203ffa
TC
54Fetch the latest tagged version of Peertube
55```
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"
57```
59c48d49 58
e5203ffa
TC
59Open the peertube directory, create a few required directories
60```
15dbc134 61$ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions
e5203ffa 62```
59c48d49 63
e5203ffa 64Download the latest version of the Peertube client, unzip it and remove the zip
afe81767 65```
15dbc134
TC
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
e5203ffa 68```
59c48d49 69
cfdd9eb4 70Install Peertube:
e5203ffa 71```
15dbc134 72$ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
09c93c20 73$ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
63bfad7e
C
74```
75
76### PeerTube configuration
77
78Copy example configuration:
79
afe81767 80```
59c48d49 81$ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
63bfad7e
C
82```
83
84Then edit the `config/production.yaml` file according to your webserver
d2000ca6 85configuration.
63bfad7e 86
30f55025
C
87**PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
88
63bfad7e
C
89### Webserver
90
e883399f
RK
91We only provide official configuration files for Nginx.
92
63bfad7e
C
93Copy the nginx configuration template:
94
afe81767 95```
59c48d49 96$ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
63bfad7e
C
97```
98
7a3864e8
M
99Then set the domain for the webserver configuration file.
100Replace `[peertube-domain]` with the domain for the peertube server.
101
102```
103$ sudo sed -i 's/peertube.example.com/[peertube-domain]/g' /etc/nginx/sites-available/peertube
104```
105
5668bf2e
C
106Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
107It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
63bfad7e 108
afe81767 109```
63bfad7e
C
110$ sudo vim /etc/nginx/sites-available/peertube
111```
112
0b495712
C
113Activate the configuration file:
114
115```
116$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
117```
118
119To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
120
121```
122$ sudo systemctl stop nginx
e6607b25 123$ sudo vim /etc/nginx/sites-available/peertube # Comment ssl_certificate and ssl_certificate_key lines
0b495712 124$ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx"
e6607b25
C
125$ sudo vim /etc/nginx/sites-available/peertube # Uncomment ssl_certificate and ssl_certificate_key lines
126$ sudo systemctl reload nginx
e883399f
RK
127```
128
129Remember your certificate will expire in 90 days, and thus needs renewal.
63bfad7e 130
0b495712 131Now you have the certificates you can reload nginx:
63bfad7e 132
afe81767 133```
63bfad7e
C
134$ sudo systemctl reload nginx
135```
136
4c86a254
GN
137**FreeBSD**
138On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
139
140```
141$ sudo pkg install dehydrated
142```
143
f74c294a
MES
144### TCP/IP Tuning
145
146**On Linux**
147
148```
149$ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
150$ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
151```
152
153Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
154scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
155links as we often encounter in a video server.
156
07aa93a8 157### systemd
63bfad7e 158
07aa93a8 159If your OS uses systemd, copy the configuration template:
63bfad7e 160
afe81767 161```
59c48d49 162$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
63bfad7e
C
163```
164
165Update the service file:
166
afe81767 167```
d2000ca6 168$ sudo vim /etc/systemd/system/peertube.service
63bfad7e
C
169```
170
63bfad7e
C
171
172Tell systemd to reload its config:
173
afe81767 174```
d2000ca6 175$ sudo systemctl daemon-reload
63bfad7e
C
176```
177
6b2ef589
C
178If you want to start PeerTube on boot:
179
180```
9625507f 181$ sudo systemctl enable peertube
6b2ef589
C
182```
183
07aa93a8 184Run:
63bfad7e 185
afe81767 186```
d2000ca6
C
187$ sudo systemctl start peertube
188$ sudo journalctl -feu peertube
63bfad7e
C
189```
190
65fcf1e9
C
191**FreeBSD**
192On FreeBSD, copy the startup script and update rc.conf:
6d55bd21
GN
193
194```
31d45e0e
MP
195$ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
196$ sudo sysrc peertube_enable="YES"
6d55bd21
GN
197```
198
07aa93a8 199Run:
6d55bd21
GN
200
201```
202$ sudo service peertube start
203```
204
67ac918d
W
205### OpenRC
206
207If your OS uses OpenRC, copy the service script:
208
209```
210$ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
211```
212
213If you want to start PeerTube on boot:
214
215```
216$ sudo rc-update add peertube default
217```
218
219Run and print last logs:
220
221```
222$ sudo /etc/init.d/peertube start
223$ tail -f /var/log/peertube/peertube.log
224```
225
63bfad7e
C
226### Administrator
227
228The administrator password is automatically generated and can be found in the
229logs. You can set another password with:
230
afe81767 231```
59c48d49 232$ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
63bfad7e
C
233```
234
3daaa192
AV
235Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
236to your own administrator password, although it must be 6 characters or more.
237
9c758359
C
238### What now?
239
240Now your instance is up you can:
241
242 * Subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin
243 * Add you instance to the public PeerTube instances index if you want to: https://instances.peertu.be/
d06caf3e 244 * Check [available CLI tools](/support/doc/tools.md)
2e3a0215 245
63bfad7e
C
246## Upgrade
247
57c36b27 248### PeerTube instance
b314f983
C
249
250**Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
251
a8b5ce95 252#### Auto (minor versions only)
1007a018 253
4246247f
LD
254The password it asks is PeerTube's database user password.
255
1007a018 256```
fbd2ad19 257$ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
1007a018
SL
258```
259
a8b5ce95
C
260#### Manually
261
ce487e1e 262Make a SQL backup
c7a9f34f
C
263
264```
265$ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
59c48d49 266 cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
43c4c639 267 sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
c7a9f34f
C
268```
269
ce487e1e 270Fetch the latest tagged version of Peertube:
23e27dd5
C
271
272```
ce487e1e 273$ 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"
23e27dd5
C
274```
275
ce487e1e 276Download the new version and unzip it:
c7a9f34f 277
afe81767 278```
ce487e1e 279$ cd /var/www/peertube/versions && \
fd206f0b 280 sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
ce487e1e
C
281 sudo -u peertube unzip -o peertube-${VERSION}.zip && \
282 sudo -u peertube rm peertube-${VERSION}.zip
283```
284
4805cff1 285Install node dependencies:
ce487e1e
C
286
287```
4805cff1 288$ cd /var/www/peertube/versions/peertube-${VERSION} && \
fbd2ad19 289 sudo -H -u peertube yarn install --production --pure-lockfile
ce487e1e
C
290```
291
4805cff1 292Copy new configuration defaults values and update your configuration file:
ce487e1e 293
63bfad7e 294```
4805cff1 295$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
a8b5ce95 296$ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
ce487e1e
C
297```
298
4805cff1 299Change the link to point to the latest version:
ce487e1e
C
300
301```
4805cff1 302$ cd /var/www/peertube && \
2519d9fe 303 sudo unlink ./peertube-latest && \
4805cff1 304 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
ce487e1e
C
305```
306
b314f983
C
307### nginx
308
309Check changes in nginx configuration:
310
311```
312$ cd /var/www/peertube/versions
313$ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
314```
315
316### systemd
317
318Check changes in systemd configuration:
319
320```
321$ cd /var/www/peertube/versions
322$ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
323```
324
325### Restart PeerTube
326
327If you changed your nginx configuration:
328
329```
330$ sudo systemctl reload nginx
331```
332
333If you changed your systemd configuration:
4805cff1 334
ce487e1e 335```
b314f983
C
336$ sudo systemctl daemon-reload
337```
338
339Restart PeerTube and check the logs:
340
341```
342$ sudo systemctl restart peertube && sudo journalctl -fu peertube
ce487e1e
C
343```
344
4c86a254 345### Things went wrong?
c7a9f34f 346
ce487e1e 347Change `peertube-latest` destination to the previous version and restore your SQL backup:
c7a9f34f
C
348
349```
350$ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
43c4c639 351 cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
c7a9f34f 352 sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
43c4c639 353 sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
c7a9f34f
C
354 sudo systemctl restart peertube
355```