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