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