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