]>
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 because it could slow down the fediverse.** | |
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 | ### Database | |
28 | ||
29 | Create the production database and a peertube user inside PostgreSQL: | |
30 | ||
31 | ``` | |
32 | $ sudo -u postgres createuser -P peertube | |
33 | $ sudo -u postgres createdb -O peertube peertube_prod | |
34 | ``` | |
35 | ||
36 | ### Prepare PeerTube directory | |
37 | ||
38 | Fetch the latest tagged version of Peertube | |
39 | ``` | |
40 | $ 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" | |
41 | ``` | |
42 | ||
43 | Open the peertube directory, create a few required directories | |
44 | ``` | |
45 | $ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions | |
46 | ``` | |
47 | ||
48 | Download the latest version of the Peertube client, unzip it and remove the zip | |
49 | ``` | |
50 | $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" | |
51 | $ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip | |
52 | ``` | |
53 | ||
54 | Install Peertube | |
55 | ``` | |
56 | $ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest | |
57 | $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile | |
58 | ``` | |
59 | ||
60 | ### PeerTube configuration | |
61 | ||
62 | Copy example configuration: | |
63 | ||
64 | ``` | |
65 | $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml | |
66 | ``` | |
67 | ||
68 | Then edit the `config/production.yaml` file according to your webserver | |
69 | configuration. | |
70 | ||
71 | ### Webserver | |
72 | ||
73 | We only provide official configuration files for Nginx. | |
74 | ||
75 | Copy the nginx configuration template: | |
76 | ||
77 | ``` | |
78 | $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube | |
79 | ``` | |
80 | ||
81 | Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations. | |
82 | It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key). | |
83 | ||
84 | ``` | |
85 | $ sudo vim /etc/nginx/sites-available/peertube | |
86 | ``` | |
87 | ||
88 | Activate the configuration file: | |
89 | ||
90 | ``` | |
91 | $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube | |
92 | ``` | |
93 | ||
94 | To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/): | |
95 | ||
96 | ``` | |
97 | $ sudo systemctl stop nginx | |
98 | $ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx" | |
99 | ``` | |
100 | ||
101 | Remember your certificate will expire in 90 days, and thus needs renewal. | |
102 | ||
103 | Now you have the certificates you can reload nginx: | |
104 | ||
105 | ``` | |
106 | $ sudo systemctl reload nginx | |
107 | ``` | |
108 | ||
109 | ### Systemd | |
110 | ||
111 | Copy the SystemD configuration template: | |
112 | ||
113 | ``` | |
114 | $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/ | |
115 | ``` | |
116 | ||
117 | Update the service file: | |
118 | ||
119 | ``` | |
120 | $ sudo vim /etc/systemd/system/peertube.service | |
121 | ``` | |
122 | ||
123 | ||
124 | Tell systemd to reload its config: | |
125 | ||
126 | ``` | |
127 | $ sudo systemctl daemon-reload | |
128 | ``` | |
129 | ||
130 | If you want to start PeerTube on boot: | |
131 | ||
132 | ``` | |
133 | $ sudo systemctl enable peertube | |
134 | ``` | |
135 | ||
136 | ### Run | |
137 | ||
138 | ``` | |
139 | $ sudo systemctl start peertube | |
140 | $ sudo journalctl -feu peertube | |
141 | ``` | |
142 | ||
143 | ### Administrator | |
144 | ||
145 | The administrator password is automatically generated and can be found in the | |
146 | logs. You can set another password with: | |
147 | ||
148 | ``` | |
149 | $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root | |
150 | ``` | |
151 | ||
152 | ## Upgrade | |
153 | ||
154 | #### Auto (minor versions only) | |
155 | ||
156 | ``` | |
157 | $ cd /var/www/peertube/peertube-latest/scripts && sudo -u peertube ./upgrade.sh | |
158 | $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml | |
159 | $ sudo systemctl restart peertube && sudo journalctl -fu peertube | |
160 | ``` | |
161 | ||
162 | #### Manually | |
163 | ||
164 | Make a SQL backup | |
165 | ||
166 | ``` | |
167 | $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \ | |
168 | cd /var/www/peertube && sudo -u peertube mkdir -p backup && \ | |
169 | sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH" | |
170 | ``` | |
171 | ||
172 | Fetch the latest tagged version of Peertube: | |
173 | ||
174 | ``` | |
175 | $ 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" | |
176 | ``` | |
177 | ||
178 | Download the new version and unzip it: | |
179 | ||
180 | ``` | |
181 | $ cd /var/www/peertube/versions && \ | |
182 | sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \ | |
183 | sudo -u peertube unzip -o peertube-${VERSION}.zip && \ | |
184 | sudo -u peertube rm peertube-${VERSION}.zip | |
185 | ``` | |
186 | ||
187 | Install node dependencies: | |
188 | ||
189 | ``` | |
190 | $ cd /var/www/peertube/versions/peertube-${VERSION} && \ | |
191 | sudo -u peertube yarn install --production --pure-lockfile | |
192 | ``` | |
193 | ||
194 | Copy new configuration defaults values and update your configuration file: | |
195 | ||
196 | ``` | |
197 | $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml | |
198 | $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml | |
199 | ``` | |
200 | ||
201 | Change the link to point to the latest version: | |
202 | ||
203 | ``` | |
204 | $ cd /var/www/peertube && \ | |
205 | sudo rm ./peertube-latest && \ | |
206 | sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest | |
207 | ``` | |
208 | ||
209 | ||
210 | Restart PeerTube: | |
211 | ``` | |
212 | $ sudo systemctl restart peertube | |
213 | ``` | |
214 | ||
215 | ### Things went wrong? | |
216 | ||
217 | Change `peertube-latest` destination to the previous version and restore your SQL backup: | |
218 | ||
219 | ``` | |
220 | $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \ | |
221 | cd /var/www/peertube && rm ./peertube-latest && \ | |
222 | sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \ | |
223 | pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH" | |
224 | sudo systemctl restart peertube | |
225 | ``` |