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