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