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