support/doc/production.md

   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.**
   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 **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
  72
  73 ### Webserver
  74
  75 We only provide official configuration files for Nginx.
  76
  77 Copy the nginx configuration template:
  78
  79 ```
  80 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
  81 ```
  82
  83 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
  84 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
  85
  86 ```
  87 $ sudo vim /etc/nginx/sites-available/peertube
  88 ```
  89
  90 Activate the configuration file:
  91
  92 ```
  93 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
  94 ```
  95
  96 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
  97
  98 ```
  99 $ sudo systemctl stop nginx
 100 $ sudo vim /etc/nginx/sites-available/peertube # Comment ssl_certificate and ssl_certificate_key lines
 101 $ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx"
 102 $ sudo vim /etc/nginx/sites-available/peertube # Uncomment ssl_certificate and ssl_certificate_key lines
 103 $ sudo systemctl reload nginx
 104 ```
 105
 106 Remember your certificate will expire in 90 days, and thus needs renewal.
 107
 108 Now you have the certificates you can reload nginx:
 109
 110 ```
 111 $ sudo systemctl reload nginx
 112 ```
 113
 114 ### systemd
 115
 116 If your OS uses systemd, copy the configuration template:
 117
 118 ```
 119 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
 120 ```
 121
 122 Update the service file:
 123
 124 ```
 125 $ sudo vim /etc/systemd/system/peertube.service
 126 ```
 127
 128
 129 Tell systemd to reload its config:
 130
 131 ```
 132 $ sudo systemctl daemon-reload
 133 ```
 134
 135 If you want to start PeerTube on boot:
 136
 137 ```
 138 $ sudo systemctl enable peertube
 139 ```
 140
 141 Run:
 142
 143 ```
 144 $ sudo systemctl start peertube
 145 $ sudo journalctl -feu peertube
 146 ```
 147
 148 ### FreeBSD
 149
 150 If you're using FreeBSD, copy the startup script and update rc.conf:
 151
 152 ```
 153 $ sudo cp /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
 154 $ sudo chmod +x /usr/local/etc/rc.d/peertube
 155 $ sudo echo peertube_enable="YES" >> /etc/rc.conf
 156 ```
 157
 158 Run:
 159
 160 ```
 161 $ sudo service peertube start
 162 ```
 163
 164 ### Administrator
 165
 166 The administrator password is automatically generated and can be found in the
 167 logs. You can set another password with:
 168
 169 ```
 170 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
 171 ```
 172
 173 Now you can subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin
 174
 175 ## Upgrade
 176
 177 #### Auto (minor versions only)
 178
 179 ```
 180 $ cd /var/www/peertube/peertube-latest/scripts && sudo -u peertube ./upgrade.sh
 181 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
 182 ```
 183
 184 #### Manually
 185
 186 Make a SQL backup
 187
 188 ```
 189 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
 190     cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
 191     sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH"
 192 ```
 193
 194 Fetch the latest tagged version of Peertube:
 195
 196 ```
 197 $ 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"
 198 ```
 199
 200 Download the new version and unzip it:
 201
 202 ```
 203 $ cd /var/www/peertube/versions && \
 204     sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
 205     sudo -u peertube unzip -o peertube-${VERSION}.zip && \
 206     sudo -u peertube rm peertube-${VERSION}.zip
 207 ```
 208
 209 Install node dependencies:
 210
 211 ```
 212 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
 213     sudo -u peertube yarn install --production --pure-lockfile
 214 ```
 215
 216 Copy new configuration defaults values and update your configuration file:
 217
 218 ```
 219 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
 220 $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
 221 ```
 222
 223 Change the link to point to the latest version:
 224
 225 ```
 226 $ cd /var/www/peertube && \
 227     sudo unlink ./peertube-latest && \
 228     sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
 229 ```
 230
 231
 232 Restart PeerTube:
 233 ```
 234 $ sudo systemctl restart peertube
 235 ```
 236
 237 ### Things went wrong?
 238
 239 Change `peertube-latest` destination to the previous version and restore your SQL backup:
 240
 241 ```
 242 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
 243     cd /var/www/peertube && unlink ./peertube-latest && \
 244     sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
 245     pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH"
 246     sudo systemctl restart peertube
 247 ```