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