# Production guide
+ * [Installation](#installation)
+ * [Upgrade](#upgrade)
+
## Installation
+**Please don't install PeerTube for production on a small device behind a low bandwidth connection because it could slow down the fediverse.**
+
### Dependencies
Follow the steps of the [dependencies guide](dependencies.md).
### PeerTube user
-Create a `peertube` user with `/home/peertube` home:
+Create a `peertube` user with `/var/www/peertube` home:
```
-$ sudo useradd -m -d /home/peertube -s /bin/bash -p peertube peertube
+$ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
+```
+
+Set its password:
+```
$ sudo passwd peertube
```
### Database
-Create production database and peertube user:
+Create the production database and a peertube user inside PostgreSQL:
```
$ sudo -u postgres createuser -P peertube
### Prepare PeerTube directory
+Fetch the latest tagged version of Peertube
```
-$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && \
- cd /home/peertube && \
- sudo -u peertube mkdir config storage versions && \
- cd versions && \
- sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
- sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip && \
- cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest && \
- cd ./peertube-latest && sudo -u peertube yarn install --production --pure-lockfile
+$ 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"
+```
+
+Open the peertube directory, create a few required directories
+```
+$ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions
+```
+
+Download the latest version of the Peertube client, unzip it and remove the zip
+```
+$ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
+$ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
+```
+
+Install Peertube
+```
+$ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
+$ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
```
### PeerTube configuration
Copy example configuration:
```
-$ cd /home/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
+$ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
```
Then edit the `config/production.yaml` file according to your webserver
Copy the nginx configuration template:
```
-$ sudo cp /home/peertube/PeerTube/support/nginx/peertube /etc/nginx/sites-available/peertube
+$ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
```
-Then modify the webserver configuration file. Please pay attention to the `alias` key of `/static/webseed` location.
-It should correspond to the path of your videos directory (set in the configuration file as `storage->videos` key).
+Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
+It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
```
$ sudo vim /etc/nginx/sites-available/peertube
root /var/www/certbot;
}
+ location ~ ^/client/(.*\.(js|css|woff2|otf|ttf|woff|eot))$ {
+ add_header Cache-Control "public, max-age=31536000, immutable";
+
+ alias /var/www/peertube/peertube-latest/client/dist/$1;
+ }
+
+ location ~ ^/static/(thumbnails|avatars)/(.*)$ {
+ add_header Cache-Control "public, max-age=31536000, immutable";
+
+ alias /var/www/peertube/storage/$1/$2;
+ }
+
location / {
proxy_pass http://localhost:9000;
proxy_set_header X-Real-IP $remote_addr;
add_header 'Access-Control-Allow-Origin' '*';
add_header 'Access-Control-Allow-Methods' 'GET, OPTIONS';
add_header 'Access-Control-Allow-Headers' 'Range,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
+
+ # Don't spam access log file with byte range requests
+ access_log off;
}
- alias /home/peertube/storage/videos;
+ alias /var/www/peertube/storage/videos;
}
# Websocket tracker
Copy the nginx configuration template:
```
-$ sudo cp /home/peertube/PeerTube/support/systemd/peertube.service /etc/systemd/system/
+$ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
```
Update the service file:
[Service]
Type=simple
Environment=NODE_ENV=production
-Environment=NODE_CONFIG_DIR=/home/peertube/config
+Environment=NODE_CONFIG_DIR=/var/www/peertube/config
User=peertube
Group=peertube
ExecStart=/usr/bin/npm start
-WorkingDirectory=/home/peertube/peertube-latest
+WorkingDirectory=/var/www/peertube/peertube-latest
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=peertube
If you want to start PeerTube on boot:
```
-$ sudo systemctl enabled peertube
+$ sudo systemctl enable peertube
```
### Run
logs. You can set another password with:
```
-$ NODE_ENV=production npm run reset-password -- -u root
+$ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
```
## Upgrade
+#### Auto
+
+Via the bash Script :
+
+```
+$ su - peertube
+$ cd scripts && ./upgrade.sh
+$ exit
+$ systemctl restart peertube
+$ systemctl status peertube
+```
+
+#### Manuel
+Make a SQL backup
+
+```
+$ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
+ cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
+ sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH"
+```
+
+Fetch the latest tagged version of Peertube:
+
+```
+$ 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"
+```
+
+Download the new version and unzip it:
```
-$ VERSION=$(curl -s https://api.github.com/repos/chocobozzz/peertube/releases/latest | grep tag_name | cut -d '"' -f 4) && \
- cd /home/peertube/versions && \
+$ cd /var/www/peertube/versions && \
sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
- sudo -u peertube unzip -o peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip && \
- cd ../ && sudo rm ./peertube-latest && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest && \
- cd ./peertube-latest && sudo -u peertube yarn install --production --pure-lockfile && \
+ sudo -u peertube unzip -o peertube-${VERSION}.zip && \
+ sudo -u peertube rm peertube-${VERSION}.zip
+```
+
+Install node dependencies:
+
+```
+$ cd /var/www/peertube/versions/peertube-${VERSION} && \
+ sudo -u peertube yarn install --production --pure-lockfile
+```
+
+Copy new configuration defaults values and update your configuration file:
+
+```
+$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
+$ diff /var/www/peertube/versions/peertube-${VERSION}/config//production.yaml.example /var/www/peertube/config/production.yaml
+```
+
+Change the link to point to the latest version:
+
+```
+$ cd /var/www/peertube && \
+ sudo rm ./peertube-latest && \
+ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
+```
+
+
+Restart PeerTube:
+```
+$ sudo systemctl restart peertube
+```
+
+### Things went wrong?
+
+Change `peertube-latest` destination to the previous version and restore your SQL backup:
+
+```
+$ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
+ cd /var/www/peertube && rm ./peertube-latest && \
+ sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
+ pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH"
sudo systemctl restart peertube
```
projects / github / Chocobozzz / PeerTube.git / blobdiff