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