]>
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 | |
a23f6c94 | 11 | ### :hammer: Dependencies |
63bfad7e | 12 | |
a23f6c94 | 13 | Follow the steps of the [dependencies guide](dependencies.md). |
63bfad7e | 14 | |
a23f6c94 | 15 | ### :construction_worker: PeerTube user |
63bfad7e | 16 | |
59c48d49 | 17 | Create a `peertube` user with `/var/www/peertube` home: |
63bfad7e | 18 | |
a23f6c94 | 19 | ```bash |
59c48d49 | 20 | $ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube |
e5203ffa TC |
21 | ``` |
22 | ||
23 | Set its password: | |
a23f6c94 | 24 | ```bash |
d2000ca6 | 25 | $ sudo passwd peertube |
63bfad7e C |
26 | ``` |
27 | ||
4c86a254 GN |
28 | **On FreeBSD** |
29 | ||
a23f6c94 | 30 | ```bash |
4c86a254 GN |
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 | ||
a23f6c94 | 36 | ### :card_file_box: Database |
63bfad7e | 37 | |
e5203ffa | 38 | Create the production database and a peertube user inside PostgreSQL: |
63bfad7e | 39 | |
a23f6c94 | 40 | ```bash |
3dc8a86c | 41 | $ cd /var/www/peertube |
d2000ca6 | 42 | $ sudo -u postgres createuser -P peertube |
c11fc2d9 | 43 | ``` |
44 | ||
2c5eab14 C |
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. | |
c11fc2d9 | 47 | |
a23f6c94 | 48 | ```bash |
0539dba8 | 49 | $ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod |
63bfad7e C |
50 | ``` |
51 | ||
57c36b27 C |
52 | Then enable extensions PeerTube needs: |
53 | ||
a23f6c94 | 54 | ```bash |
57c36b27 C |
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 | ||
a23f6c94 | 59 | ### :page_facing_up: Prepare PeerTube directory |
63bfad7e | 60 | |
e5203ffa | 61 | Fetch the latest tagged version of Peertube |
a23f6c94 | 62 | ```bash |
e5203ffa TC |
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 | ``` | |
59c48d49 | 65 | |
e5203ffa | 66 | Open the peertube directory, create a few required directories |
a23f6c94 | 67 | ```bash |
d8658f0f C |
68 | $ cd /var/www/peertube |
69 | $ sudo -u peertube mkdir config storage versions | |
6d8e1f28 | 70 | $ sudo -u peertube chmod 750 config/ |
e5203ffa | 71 | ``` |
59c48d49 | 72 | |
e5203ffa | 73 | Download the latest version of the Peertube client, unzip it and remove the zip |
a23f6c94 | 74 | ```bash |
d8658f0f | 75 | $ cd /var/www/peertube/versions |
15dbc134 | 76 | $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" |
c201278d | 77 | $ sudo -u peertube unzip -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip |
e5203ffa | 78 | ``` |
59c48d49 | 79 | |
cfdd9eb4 | 80 | Install Peertube: |
a23f6c94 | 81 | ```bash |
d8658f0f C |
82 | $ cd /var/www/peertube |
83 | $ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest | |
09c93c20 | 84 | $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile |
63bfad7e C |
85 | ``` |
86 | ||
a23f6c94 | 87 | ### :wrench: PeerTube configuration |
63bfad7e | 88 | |
4948dcdb C |
89 | Copy the default configuration file that contains the default configuration provided by PeerTube. |
90 | You **must not** update this file. | |
91 | ||
a23f6c94 | 92 | ```bash |
d8658f0f C |
93 | $ cd /var/www/peertube |
94 | $ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml | |
4948dcdb C |
95 | ``` |
96 | ||
97 | Now copy the production example configuration: | |
63bfad7e | 98 | |
a23f6c94 | 99 | ```bash |
d8658f0f C |
100 | $ cd /var/www/peertube |
101 | $ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml | |
63bfad7e C |
102 | ``` |
103 | ||
104 | Then edit the `config/production.yaml` file according to your webserver | |
d8658f0f C |
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`. | |
63bfad7e | 107 | |
7cf88d09 | 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. |
30f55025 | 109 | |
a23f6c94 | 110 | ### :truck: Webserver |
63bfad7e | 111 | |
e883399f RK |
112 | We only provide official configuration files for Nginx. |
113 | ||
63bfad7e C |
114 | Copy the nginx configuration template: |
115 | ||
a23f6c94 | 116 | ```bash |
59c48d49 | 117 | $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube |
63bfad7e C |
118 | ``` |
119 | ||
2c92b063 C |
120 | Then set the domain for the webserver configuration file. |
121 | Replace `[peertube-domain]` with the domain for the peertube server. | |
7a3864e8 | 122 | |
a23f6c94 | 123 | ```bash |
1a9b141d | 124 | $ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube |
feb0f998 | 125 | $ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube |
7a3864e8 M |
126 | ``` |
127 | ||
5668bf2e C |
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). | |
63bfad7e | 130 | |
a23f6c94 | 131 | ```bash |
63bfad7e C |
132 | $ sudo vim /etc/nginx/sites-available/peertube |
133 | ``` | |
134 | ||
0b495712 C |
135 | Activate the configuration file: |
136 | ||
a23f6c94 | 137 | ```bash |
0b495712 C |
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 | ||
a23f6c94 | 143 | ```bash |
0b495712 | 144 | $ sudo systemctl stop nginx |
f35f23d8 | 145 | $ sudo certbot certonly --standalone --post-hook "systemctl restart nginx" |
e6607b25 | 146 | $ sudo systemctl reload nginx |
e883399f RK |
147 | ``` |
148 | ||
0b495712 | 149 | Now you have the certificates you can reload nginx: |
63bfad7e | 150 | |
a23f6c94 | 151 | ```bash |
63bfad7e C |
152 | $ sudo systemctl reload nginx |
153 | ``` | |
154 | ||
d8658f0f C |
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 | ||
a23f6c94 | 158 | ```bash |
d8658f0f | 159 | $ # Replace authenticator = standalone by authenticator = webroot |
08a9ee19 | 160 | $ # Add webroot_path = /var/www/certbot |
d8658f0f C |
161 | $ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf |
162 | ``` | |
163 | ||
4c86a254 GN |
164 | **FreeBSD** |
165 | On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/) | |
166 | ||
a23f6c94 | 167 | ```bash |
4c86a254 GN |
168 | $ sudo pkg install dehydrated |
169 | ``` | |
170 | ||
a23f6c94 | 171 | ### :alembic: TCP/IP Tuning |
f74c294a MES |
172 | |
173 | **On Linux** | |
174 | ||
a23f6c94 | 175 | ```bash |
f74c294a MES |
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 | ||
a23f6c94 | 184 | ### :bricks: systemd |
63bfad7e | 185 | |
07aa93a8 | 186 | If your OS uses systemd, copy the configuration template: |
63bfad7e | 187 | |
a23f6c94 | 188 | ```bash |
59c48d49 | 189 | $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/ |
63bfad7e C |
190 | ``` |
191 | ||
96df6ca6 | 192 | Check the service file (PeerTube paths and security directives): |
63bfad7e | 193 | |
a23f6c94 | 194 | ```bash |
d2000ca6 | 195 | $ sudo vim /etc/systemd/system/peertube.service |
63bfad7e C |
196 | ``` |
197 | ||
63bfad7e C |
198 | |
199 | Tell systemd to reload its config: | |
200 | ||
a23f6c94 | 201 | ```bash |
d2000ca6 | 202 | $ sudo systemctl daemon-reload |
63bfad7e C |
203 | ``` |
204 | ||
6b2ef589 C |
205 | If you want to start PeerTube on boot: |
206 | ||
a23f6c94 | 207 | ```bash |
9625507f | 208 | $ sudo systemctl enable peertube |
6b2ef589 C |
209 | ``` |
210 | ||
07aa93a8 | 211 | Run: |
63bfad7e | 212 | |
a23f6c94 | 213 | ```bash |
d2000ca6 C |
214 | $ sudo systemctl start peertube |
215 | $ sudo journalctl -feu peertube | |
63bfad7e C |
216 | ``` |
217 | ||
65fcf1e9 C |
218 | **FreeBSD** |
219 | On FreeBSD, copy the startup script and update rc.conf: | |
6d55bd21 | 220 | |
a23f6c94 | 221 | ```bash |
31d45e0e MP |
222 | $ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/ |
223 | $ sudo sysrc peertube_enable="YES" | |
6d55bd21 GN |
224 | ``` |
225 | ||
07aa93a8 | 226 | Run: |
6d55bd21 | 227 | |
a23f6c94 | 228 | ```bash |
6d55bd21 GN |
229 | $ sudo service peertube start |
230 | ``` | |
231 | ||
a23f6c94 | 232 | ### :bricks: OpenRC |
67ac918d W |
233 | |
234 | If your OS uses OpenRC, copy the service script: | |
235 | ||
a23f6c94 | 236 | ```bash |
67ac918d W |
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 | ||
a23f6c94 | 242 | ```bash |
67ac918d W |
243 | $ sudo rc-update add peertube default |
244 | ``` | |
245 | ||
246 | Run and print last logs: | |
247 | ||
a23f6c94 | 248 | ```bash |
67ac918d W |
249 | $ sudo /etc/init.d/peertube start |
250 | $ tail -f /var/log/peertube/peertube.log | |
251 | ``` | |
252 | ||
a23f6c94 | 253 | ### :technologist: Administrator |
63bfad7e | 254 | |
d8658f0f C |
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: | |
63bfad7e | 257 | |
a23f6c94 | 258 | ```bash |
59c48d49 | 259 | $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root |
63bfad7e C |
260 | ``` |
261 | ||
3daaa192 AV |
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 | ||
a23f6c94 | 265 | ### :tada: What now? |
9c758359 C |
266 | |
267 | Now your instance is up you can: | |
2c92b063 | 268 | |
4d582cec | 269 | * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/ |
d06caf3e | 270 | * Check [available CLI tools](/support/doc/tools.md) |
2e3a0215 | 271 | |
63bfad7e C |
272 | ## Upgrade |
273 | ||
57c36b27 | 274 | ### PeerTube instance |
b314f983 C |
275 | |
276 | **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md | |
277 | ||
c0605e6e | 278 | #### Auto |
1007a018 | 279 | |
4246247f LD |
280 | The password it asks is PeerTube's database user password. |
281 | ||
a23f6c94 | 282 | ```bash |
fbd2ad19 | 283 | $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh |
188aa774 | 284 | $ sudo systemctl restart peertube # Or use your OS command to restart PeerTube if you don't use systemd |
1007a018 SL |
285 | ``` |
286 | ||
a8b5ce95 C |
287 | #### Manually |
288 | ||
ce487e1e | 289 | Make a SQL backup |
c7a9f34f | 290 | |
a23f6c94 | 291 | ```bash |
c7a9f34f | 292 | $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \ |
59c48d49 | 293 | cd /var/www/peertube && sudo -u peertube mkdir -p backup && \ |
43c4c639 | 294 | sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null |
c7a9f34f C |
295 | ``` |
296 | ||
ce487e1e | 297 | Fetch the latest tagged version of Peertube: |
23e27dd5 | 298 | |
a23f6c94 | 299 | ```bash |
ce487e1e | 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" |
23e27dd5 C |
301 | ``` |
302 | ||
ce487e1e | 303 | Download the new version and unzip it: |
c7a9f34f | 304 | |
a23f6c94 | 305 | ```bash |
ce487e1e | 306 | $ cd /var/www/peertube/versions && \ |
fd206f0b | 307 | sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \ |
ce487e1e C |
308 | sudo -u peertube unzip -o peertube-${VERSION}.zip && \ |
309 | sudo -u peertube rm peertube-${VERSION}.zip | |
310 | ``` | |
311 | ||
4805cff1 | 312 | Install node dependencies: |
ce487e1e | 313 | |
a23f6c94 | 314 | ```bash |
4805cff1 | 315 | $ cd /var/www/peertube/versions/peertube-${VERSION} && \ |
fbd2ad19 | 316 | sudo -H -u peertube yarn install --production --pure-lockfile |
ce487e1e C |
317 | ``` |
318 | ||
4805cff1 | 319 | Copy new configuration defaults values and update your configuration file: |
ce487e1e | 320 | |
a23f6c94 | 321 | ```bash |
4805cff1 | 322 | $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml |
a8b5ce95 | 323 | $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml |
ce487e1e C |
324 | ``` |
325 | ||
4805cff1 | 326 | Change the link to point to the latest version: |
ce487e1e | 327 | |
a23f6c94 | 328 | ```bash |
4805cff1 | 329 | $ cd /var/www/peertube && \ |
2519d9fe | 330 | sudo unlink ./peertube-latest && \ |
4805cff1 | 331 | sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest |
ce487e1e C |
332 | ``` |
333 | ||
b314f983 C |
334 | ### nginx |
335 | ||
336 | Check changes in nginx configuration: | |
337 | ||
a23f6c94 | 338 | ```bash |
b314f983 C |
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 | ||
a23f6c94 | 347 | ```bash |
b314f983 C |
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 | ||
a23f6c94 | 356 | ```bash |
b314f983 C |
357 | $ sudo systemctl reload nginx |
358 | ``` | |
359 | ||
360 | If you changed your systemd configuration: | |
4805cff1 | 361 | |
a23f6c94 | 362 | ```bash |
b314f983 C |
363 | $ sudo systemctl daemon-reload |
364 | ``` | |
365 | ||
366 | Restart PeerTube and check the logs: | |
367 | ||
a23f6c94 | 368 | ```bash |
b314f983 | 369 | $ sudo systemctl restart peertube && sudo journalctl -fu peertube |
ce487e1e C |
370 | ``` |
371 | ||
4c86a254 | 372 | ### Things went wrong? |
c7a9f34f | 373 | |
ce487e1e | 374 | Change `peertube-latest` destination to the previous version and restore your SQL backup: |
c7a9f34f | 375 | |
a23f6c94 | 376 | ```bash |
c7a9f34f | 377 | $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \ |
43c4c639 | 378 | cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \ |
c7a9f34f | 379 | sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \ |
43c4c639 | 380 | sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \ |
c7a9f34f C |
381 | sudo systemctl restart peertube |
382 | ``` |