]>
Commit | Line | Data |
---|---|---|
63bfad7e C |
1 | # Production guide |
2 | ||
4df6a1b8 | 3 | * [Installation](#installation) |
4c86a254 | 4 | * [Upgrade](#upgrade) |
4df6a1b8 | 5 | |
63bfad7e C |
6 | ## Installation |
7 | ||
b4d1af3d | 8 | Please don't install PeerTube for production on a small device behind a low bandwidth connection (example: a Raspberry PI behind your ADSL link) because it could slow down the fediverse. See the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) for more information. |
1185c246 | 9 | |
63bfad7e C |
10 | ### Dependencies |
11 | ||
b4d1af3d | 12 | **Follow the steps of the [dependencies guide](dependencies.md).** |
63bfad7e C |
13 | |
14 | ### PeerTube user | |
15 | ||
59c48d49 | 16 | Create a `peertube` user with `/var/www/peertube` home: |
63bfad7e | 17 | |
afe81767 | 18 | ``` |
59c48d49 | 19 | $ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube |
e5203ffa TC |
20 | ``` |
21 | ||
22 | Set its password: | |
23 | ``` | |
d2000ca6 | 24 | $ sudo passwd peertube |
63bfad7e C |
25 | ``` |
26 | ||
4c86a254 GN |
27 | **On FreeBSD** |
28 | ||
29 | ``` | |
30 | $ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m | |
31 | $ sudo passwd peertube | |
32 | ``` | |
33 | or use `adduser` to create it interactively. | |
34 | ||
63bfad7e C |
35 | ### Database |
36 | ||
e5203ffa | 37 | Create the production database and a peertube user inside PostgreSQL: |
63bfad7e | 38 | |
afe81767 | 39 | ``` |
d2000ca6 C |
40 | $ sudo -u postgres createuser -P peertube |
41 | $ sudo -u postgres createdb -O peertube peertube_prod | |
63bfad7e C |
42 | ``` |
43 | ||
57c36b27 C |
44 | Then enable extensions PeerTube needs: |
45 | ||
46 | ``` | |
47 | $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod | |
48 | $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod | |
49 | ``` | |
50 | ||
d2000ca6 | 51 | ### Prepare PeerTube directory |
63bfad7e | 52 | |
e5203ffa TC |
53 | Fetch the latest tagged version of Peertube |
54 | ``` | |
55 | $ 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" | |
56 | ``` | |
59c48d49 | 57 | |
e5203ffa TC |
58 | Open the peertube directory, create a few required directories |
59 | ``` | |
15dbc134 | 60 | $ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions |
e5203ffa | 61 | ``` |
59c48d49 | 62 | |
e5203ffa | 63 | Download the latest version of the Peertube client, unzip it and remove the zip |
afe81767 | 64 | ``` |
15dbc134 TC |
65 | $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" |
66 | $ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip | |
e5203ffa | 67 | ``` |
59c48d49 | 68 | |
cfdd9eb4 | 69 | Install Peertube: |
e5203ffa | 70 | ``` |
15dbc134 | 71 | $ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest |
09c93c20 | 72 | $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile |
63bfad7e C |
73 | ``` |
74 | ||
75 | ### PeerTube configuration | |
76 | ||
77 | Copy example configuration: | |
78 | ||
afe81767 | 79 | ``` |
59c48d49 | 80 | $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml |
63bfad7e C |
81 | ``` |
82 | ||
83 | Then edit the `config/production.yaml` file according to your webserver | |
d2000ca6 | 84 | configuration. |
63bfad7e | 85 | |
30f55025 C |
86 | **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start. |
87 | ||
63bfad7e C |
88 | ### Webserver |
89 | ||
e883399f RK |
90 | We only provide official configuration files for Nginx. |
91 | ||
63bfad7e C |
92 | Copy the nginx configuration template: |
93 | ||
afe81767 | 94 | ``` |
59c48d49 | 95 | $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube |
63bfad7e C |
96 | ``` |
97 | ||
5668bf2e C |
98 | Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations. |
99 | It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key). | |
63bfad7e | 100 | |
afe81767 | 101 | ``` |
63bfad7e C |
102 | $ sudo vim /etc/nginx/sites-available/peertube |
103 | ``` | |
104 | ||
0b495712 C |
105 | Activate the configuration file: |
106 | ||
107 | ``` | |
108 | $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube | |
109 | ``` | |
110 | ||
111 | To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/): | |
112 | ||
113 | ``` | |
114 | $ sudo systemctl stop nginx | |
e6607b25 | 115 | $ sudo vim /etc/nginx/sites-available/peertube # Comment ssl_certificate and ssl_certificate_key lines |
0b495712 | 116 | $ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx" |
e6607b25 C |
117 | $ sudo vim /etc/nginx/sites-available/peertube # Uncomment ssl_certificate and ssl_certificate_key lines |
118 | $ sudo systemctl reload nginx | |
e883399f RK |
119 | ``` |
120 | ||
121 | Remember your certificate will expire in 90 days, and thus needs renewal. | |
63bfad7e | 122 | |
0b495712 | 123 | Now you have the certificates you can reload nginx: |
63bfad7e | 124 | |
afe81767 | 125 | ``` |
63bfad7e C |
126 | $ sudo systemctl reload nginx |
127 | ``` | |
128 | ||
4c86a254 GN |
129 | **FreeBSD** |
130 | On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/) | |
131 | ||
132 | ``` | |
133 | $ sudo pkg install dehydrated | |
134 | ``` | |
135 | ||
07aa93a8 | 136 | ### systemd |
63bfad7e | 137 | |
07aa93a8 | 138 | If your OS uses systemd, copy the configuration template: |
63bfad7e | 139 | |
afe81767 | 140 | ``` |
59c48d49 | 141 | $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/ |
63bfad7e C |
142 | ``` |
143 | ||
144 | Update the service file: | |
145 | ||
afe81767 | 146 | ``` |
d2000ca6 | 147 | $ sudo vim /etc/systemd/system/peertube.service |
63bfad7e C |
148 | ``` |
149 | ||
63bfad7e C |
150 | |
151 | Tell systemd to reload its config: | |
152 | ||
afe81767 | 153 | ``` |
d2000ca6 | 154 | $ sudo systemctl daemon-reload |
63bfad7e C |
155 | ``` |
156 | ||
6b2ef589 C |
157 | If you want to start PeerTube on boot: |
158 | ||
159 | ``` | |
9625507f | 160 | $ sudo systemctl enable peertube |
6b2ef589 C |
161 | ``` |
162 | ||
07aa93a8 | 163 | Run: |
63bfad7e | 164 | |
afe81767 | 165 | ``` |
d2000ca6 C |
166 | $ sudo systemctl start peertube |
167 | $ sudo journalctl -feu peertube | |
63bfad7e C |
168 | ``` |
169 | ||
6d55bd21 GN |
170 | ### FreeBSD |
171 | ||
07aa93a8 | 172 | If you're using FreeBSD, copy the startup script and update rc.conf: |
6d55bd21 GN |
173 | |
174 | ``` | |
175 | $ sudo cp /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/ | |
176 | $ sudo chmod +x /usr/local/etc/rc.d/peertube | |
177 | $ sudo echo peertube_enable="YES" >> /etc/rc.conf | |
178 | ``` | |
179 | ||
07aa93a8 | 180 | Run: |
6d55bd21 GN |
181 | |
182 | ``` | |
183 | $ sudo service peertube start | |
184 | ``` | |
185 | ||
63bfad7e C |
186 | ### Administrator |
187 | ||
188 | The administrator password is automatically generated and can be found in the | |
189 | logs. You can set another password with: | |
190 | ||
afe81767 | 191 | ``` |
59c48d49 | 192 | $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root |
63bfad7e C |
193 | ``` |
194 | ||
9c758359 C |
195 | ### What now? |
196 | ||
197 | Now your instance is up you can: | |
198 | ||
199 | * Subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin | |
200 | * Add you instance to the public PeerTube instances index if you want to: https://instances.peertu.be/ | |
2e3a0215 | 201 | |
63bfad7e C |
202 | ## Upgrade |
203 | ||
57c36b27 | 204 | ### PeerTube instance |
b314f983 C |
205 | |
206 | **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md | |
207 | ||
a8b5ce95 | 208 | #### Auto (minor versions only) |
1007a018 | 209 | |
4246247f LD |
210 | The password it asks is PeerTube's database user password. |
211 | ||
1007a018 | 212 | ``` |
fbd2ad19 | 213 | $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh |
1007a018 SL |
214 | ``` |
215 | ||
a8b5ce95 C |
216 | #### Manually |
217 | ||
ce487e1e | 218 | Make a SQL backup |
c7a9f34f C |
219 | |
220 | ``` | |
221 | $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \ | |
59c48d49 | 222 | cd /var/www/peertube && sudo -u peertube mkdir -p backup && \ |
c7a9f34f C |
223 | sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH" |
224 | ``` | |
225 | ||
ce487e1e | 226 | Fetch the latest tagged version of Peertube: |
23e27dd5 C |
227 | |
228 | ``` | |
ce487e1e | 229 | $ 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 |
230 | ``` |
231 | ||
ce487e1e | 232 | Download the new version and unzip it: |
c7a9f34f | 233 | |
afe81767 | 234 | ``` |
ce487e1e | 235 | $ cd /var/www/peertube/versions && \ |
fd206f0b | 236 | sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \ |
ce487e1e C |
237 | sudo -u peertube unzip -o peertube-${VERSION}.zip && \ |
238 | sudo -u peertube rm peertube-${VERSION}.zip | |
239 | ``` | |
240 | ||
4805cff1 | 241 | Install node dependencies: |
ce487e1e C |
242 | |
243 | ``` | |
4805cff1 | 244 | $ cd /var/www/peertube/versions/peertube-${VERSION} && \ |
fbd2ad19 | 245 | sudo -H -u peertube yarn install --production --pure-lockfile |
ce487e1e C |
246 | ``` |
247 | ||
4805cff1 | 248 | Copy new configuration defaults values and update your configuration file: |
ce487e1e | 249 | |
63bfad7e | 250 | ``` |
4805cff1 | 251 | $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml |
a8b5ce95 | 252 | $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml |
ce487e1e C |
253 | ``` |
254 | ||
4805cff1 | 255 | Change the link to point to the latest version: |
ce487e1e C |
256 | |
257 | ``` | |
4805cff1 | 258 | $ cd /var/www/peertube && \ |
2519d9fe | 259 | sudo unlink ./peertube-latest && \ |
4805cff1 | 260 | sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest |
ce487e1e C |
261 | ``` |
262 | ||
b314f983 C |
263 | ### nginx |
264 | ||
265 | Check changes in nginx configuration: | |
266 | ||
267 | ``` | |
268 | $ cd /var/www/peertube/versions | |
269 | $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube" | |
270 | ``` | |
271 | ||
272 | ### systemd | |
273 | ||
274 | Check changes in systemd configuration: | |
275 | ||
276 | ``` | |
277 | $ cd /var/www/peertube/versions | |
278 | $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service" | |
279 | ``` | |
280 | ||
281 | ### Restart PeerTube | |
282 | ||
283 | If you changed your nginx configuration: | |
284 | ||
285 | ``` | |
286 | $ sudo systemctl reload nginx | |
287 | ``` | |
288 | ||
289 | If you changed your systemd configuration: | |
4805cff1 | 290 | |
ce487e1e | 291 | ``` |
b314f983 C |
292 | $ sudo systemctl daemon-reload |
293 | ``` | |
294 | ||
295 | Restart PeerTube and check the logs: | |
296 | ||
297 | ``` | |
298 | $ sudo systemctl restart peertube && sudo journalctl -fu peertube | |
ce487e1e C |
299 | ``` |
300 | ||
4c86a254 | 301 | ### Things went wrong? |
c7a9f34f | 302 | |
ce487e1e | 303 | Change `peertube-latest` destination to the previous version and restore your SQL backup: |
c7a9f34f C |
304 | |
305 | ``` | |
306 | $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \ | |
2519d9fe | 307 | cd /var/www/peertube && unlink ./peertube-latest && \ |
c7a9f34f | 308 | sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \ |
f529f983 | 309 | pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH" |
c7a9f34f C |
310 | sudo systemctl restart peertube |
311 | ``` |