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. See the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) for more information.
   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 **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
  35 ### Database
  36
  37 Create the production database and a peertube user inside PostgreSQL:
  38
  39 ```
  40 $ sudo -u postgres createuser -P peertube
  41 $ sudo -u postgres createdb -O peertube peertube_prod
  42 ```
  43
  44 Then enable extensions PeerTube needs:
  45
  46 ```
  47 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
  48 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
  49 ```
  50
  51 ### Prepare PeerTube directory
  52
  53 Fetch the latest tagged version of Peertube
  54 ```
  55 $ 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"
  56 ```
  57
  58 Open the peertube directory, create a few required directories
  59 ```
  60 $ cd /var/www/peertube && sudo -u peertube mkdir config storage versions && cd versions
  61 ```
  62
  63 Download the latest version of the Peertube client, unzip it and remove the zip
  64 ```
  65 $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
  66 $ sudo -u peertube unzip peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
  67 ```
  68
  69 Install Peertube:
  70 ```
  71 $ cd ../ && sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
  72 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
  73 ```
  74
  75 ### PeerTube configuration
  76
  77 Copy example configuration:
  78
  79 ```
  80 $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
  81 ```
  82
  83 Then edit the `config/production.yaml` file according to your webserver
  84 configuration.
  85
  86 **PeerTube does not support webserver host change**. Keep in mind your domain name is definitive after your first PeerTube start.
  87
  88 ### Webserver
  89
  90 We only provide official configuration files for Nginx.
  91
  92 Copy the nginx configuration template:
  93
  94 ```
  95 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
  96 ```
  97
  98 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
  99 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
 100
 101 ```
 102 $ sudo vim /etc/nginx/sites-available/peertube
 103 ```
 104
 105 Activate the configuration file:
 106
 107 ```
 108 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
 109 ```
 110
 111 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
 112
 113 ```
 114 $ sudo systemctl stop nginx
 115 $ sudo vim /etc/nginx/sites-available/peertube # Comment ssl_certificate and ssl_certificate_key lines
 116 $ sudo certbot --authenticator standalone --installer nginx --post-hook "systemctl start nginx"
 117 $ sudo vim /etc/nginx/sites-available/peertube # Uncomment ssl_certificate and ssl_certificate_key lines
 118 $ sudo systemctl reload nginx
 119 ```
 120
 121 Remember your certificate will expire in 90 days, and thus needs renewal.
 122
 123 Now you have the certificates you can reload nginx:
 124
 125 ```
 126 $ sudo systemctl reload nginx
 127 ```
 128
 129 **FreeBSD**
 130 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
 131
 132 ```
 133 $ sudo pkg install dehydrated
 134 ```
 135
 136 ### systemd
 137
 138 If your OS uses systemd, copy the configuration template:
 139
 140 ```
 141 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
 142 ```
 143
 144 Update the service file:
 145
 146 ```
 147 $ sudo vim /etc/systemd/system/peertube.service
 148 ```
 149
 150
 151 Tell systemd to reload its config:
 152
 153 ```
 154 $ sudo systemctl daemon-reload
 155 ```
 156
 157 If you want to start PeerTube on boot:
 158
 159 ```
 160 $ sudo systemctl enable peertube
 161 ```
 162
 163 Run:
 164
 165 ```
 166 $ sudo systemctl start peertube
 167 $ sudo journalctl -feu peertube
 168 ```
 169
 170 ### FreeBSD
 171
 172 If you're using FreeBSD, copy the startup script and update rc.conf:
 173
 174 ```
 175 $ sudo cp /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
 176 $ sudo chmod +x /usr/local/etc/rc.d/peertube
 177 $ sudo echo peertube_enable="YES" >> /etc/rc.conf
 178 ```
 179
 180 Run:
 181
 182 ```
 183 $ sudo service peertube start
 184 ```
 185
 186 ### Administrator
 187
 188 The administrator password is automatically generated and can be found in the
 189 logs. You can set another password with:
 190
 191 ```
 192 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
 193 ```
 194
 195 ### What now?
 196
 197 Now your instance is up you can:
 198
 199  * Subscribe to the mailing list for PeerTube administrators: https://framalistes.org/sympa/subscribe/peertube-admin
 200  * Add you instance to the public PeerTube instances index if you want to: https://instances.peertu.be/
 201
 202 ## Upgrade
 203
 204 ### PeerTube instance
 205
 206 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
 207
 208 #### Auto (minor versions only)
 209
 210 The password it asks is PeerTube's database user password.
 211
 212 ```
 213 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
 214 ```
 215
 216 #### Manually
 217
 218 Make a SQL backup
 219
 220 ```
 221 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
 222     cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
 223     sudo pg_dump -U peertube -W -h localhost -F c peertube_prod -f "$SQL_BACKUP_PATH"
 224 ```
 225
 226 Fetch the latest tagged version of Peertube:
 227
 228 ```
 229 $ 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"
 230 ```
 231
 232 Download the new version and unzip it:
 233
 234 ```
 235 $ cd /var/www/peertube/versions && \
 236     sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
 237     sudo -u peertube unzip -o peertube-${VERSION}.zip && \
 238     sudo -u peertube rm peertube-${VERSION}.zip
 239 ```
 240
 241 Install node dependencies:
 242
 243 ```
 244 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
 245     sudo -H -u peertube yarn install --production --pure-lockfile
 246 ```
 247
 248 Copy new configuration defaults values and update your configuration file:
 249
 250 ```
 251 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
 252 $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
 253 ```
 254
 255 Change the link to point to the latest version:
 256
 257 ```
 258 $ cd /var/www/peertube && \
 259     sudo unlink ./peertube-latest && \
 260     sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
 261 ```
 262
 263 ### nginx
 264
 265 Check changes in nginx configuration:
 266
 267 ```
 268 $ cd /var/www/peertube/versions
 269 $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
 270 ```
 271
 272 ### systemd
 273
 274 Check changes in systemd configuration:
 275
 276 ```
 277 $ cd /var/www/peertube/versions
 278 $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
 279 ```
 280
 281 ### Restart PeerTube
 282
 283 If you changed your nginx configuration:
 284
 285 ```
 286 $ sudo systemctl reload nginx
 287 ```
 288
 289 If you changed your systemd configuration:
 290
 291 ```
 292 $ sudo systemctl daemon-reload
 293 ```
 294
 295 Restart PeerTube and check the logs:
 296
 297 ```
 298 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
 299 ```
 300
 301 ### Things went wrong?
 302
 303 Change `peertube-latest` destination to the previous version and restore your SQL backup:
 304
 305 ```
 306 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
 307     cd /var/www/peertube && unlink ./peertube-latest && \
 308     sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
 309     pg_restore -U peertube -W -h localhost -c -d peertube_prod "$SQL_BACKUP_PATH"
 310     sudo systemctl restart peertube
 311 ```