3 * [Installation](#installation)
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).
13 **Follow the steps of the [dependencies guide](dependencies.md).**
17 Create a `peertube` user with `/var/www/peertube` home:
20 $ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
25 $ sudo passwd peertube
31 $ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
32 $ sudo passwd peertube
34 or use `adduser` to create it interactively.
38 Create the production database and a peertube user inside PostgreSQL:
41 $ sudo -u postgres createuser -P peertube
42 $ sudo -u postgres createdb -O peertube peertube_prod
45 Then enable extensions PeerTube needs:
48 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
49 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
52 ### Prepare PeerTube directory
54 Fetch the latest tagged version of Peertube
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"
59 Open the peertube directory, create a few required directories
61 $ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions
64 Download the latest version of the Peertube client, unzip it and remove the zip
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
72 $ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
73 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
76 ### PeerTube configuration
78 Copy example configuration:
81 $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
84 Then edit the `config/production.yaml` file according to your webserver
87 **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
91 We only provide official configuration files for Nginx.
93 Copy the nginx configuration template:
96 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
99 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
100 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
103 $ sudo vim /etc/nginx/sites-available/peertube
106 Activate the configuration file:
109 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
112 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
115 $ sudo systemctl stop nginx
116 $ sudo vim /etc/nginx/sites-available/peertube # Comment ssl_certificate and ssl_certificate_key lines
117 $ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx"
118 $ sudo vim /etc/nginx/sites-available/peertube # Uncomment ssl_certificate and ssl_certificate_key lines
119 $ sudo systemctl reload nginx
122 Remember your certificate will expire in 90 days, and thus needs renewal.
124 Now you have the certificates you can reload nginx:
127 $ sudo systemctl reload nginx
131 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
134 $ sudo pkg install dehydrated
139 If your OS uses systemd, copy the configuration template:
142 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
145 Update the service file:
148 $ sudo vim /etc/systemd/system/peertube.service
152 Tell systemd to reload its config:
155 $ sudo systemctl daemon-reload
158 If you want to start PeerTube on boot:
161 $ sudo systemctl enable peertube
167 $ sudo systemctl start peertube
168 $ sudo journalctl -feu peertube
173 If you're using FreeBSD, copy the startup script and update rc.conf:
176 $ sudo cp /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
177 $ sudo chmod +x /usr/local/etc/rc.d/peertube
178 $ sudo echo peertube_enable="YES" >> /etc/rc.conf
184 $ sudo service peertube start
189 The administrator password is automatically generated and can be found in the
190 logs. You can set another password with:
193 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
198 Now your instance is up you can:
200 * Subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin
201 * Add you instance to the public PeerTube instances index if you want to: https://instances.peertu.be/
205 ### PeerTube instance
207 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
209 #### Auto (minor versions only)
211 The password it asks is PeerTube's database user password.
214 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
222 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
223 cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
224 sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH"
227 Fetch the latest tagged version of Peertube:
230 $ 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"
233 Download the new version and unzip it:
236 $ cd /var/www/peertube/versions && \
237 sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
238 sudo -u peertube unzip -o peertube-${VERSION}.zip && \
239 sudo -u peertube rm peertube-${VERSION}.zip
242 Install node dependencies:
245 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
246 sudo -H -u peertube yarn install --production --pure-lockfile
249 Copy new configuration defaults values and update your configuration file:
252 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
253 $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
256 Change the link to point to the latest version:
259 $ cd /var/www/peertube && \
260 sudo unlink ./peertube-latest && \
261 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
266 Check changes in nginx configuration:
269 $ cd /var/www/peertube/versions
270 $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
275 Check changes in systemd configuration:
278 $ cd /var/www/peertube/versions
279 $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
284 If you changed your nginx configuration:
287 $ sudo systemctl reload nginx
290 If you changed your systemd configuration:
293 $ sudo systemctl daemon-reload
296 Restart PeerTube and check the logs:
299 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
302 ### Things went wrong?
304 Change `peertube-latest` destination to the previous version and restore your SQL backup:
307 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
308 cd /var/www/peertube && unlink ./peertube-latest && \
309 sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
310 pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH"
311 sudo systemctl restart peertube