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 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).
  10
  11 ### Dependencies
  12
  13 **Follow the steps of the [dependencies guide](dependencies.md).**
  14
  15 ### PeerTube user
  16
  17 Create a `peertube` user with `/var/www/peertube` home:
  18
  19 ```
  20 $ sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube
  21 ```
  22
  23 Set its password:
  24 ```
  25 $ sudo passwd peertube
  26 ```
  27
  28 **On FreeBSD**
  29
  30 ```
  31 $ sudo pw useradd -n peertube -d /var/www/peertube -s /usr/local/bin/bash -m
  32 $ sudo passwd peertube
  33 ```
  34 or use `adduser` to create it interactively.
  35
  36 ### Database
  37
  38 Create the production database and a peertube user inside PostgreSQL:
  39
  40 ```
  41 $ sudo -u postgres createuser -P peertube
  42 ```
  43
  44 Here you should enter a password for PostgreSQL `peertube` user, that should be copied in `production.yaml` file.
  45 Don't just hit enter else it will be empty.
  46
  47 ```
  48 $ sudo -u postgres createdb -O peertube -E UTF8 -T template0 peertube_prod
  49 ```
  50
  51 Then enable extensions PeerTube needs:
  52
  53 ```
  54 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_prod
  55 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_prod
  56 ```
  57
  58 ### Prepare PeerTube directory
  59
  60 Fetch the latest tagged version of Peertube
  61 ```
  62 $ 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"
  63 ```
  64
  65 Open the peertube directory, create a few required directories
  66 ```
  67 $ cd /var/www/peertube
  68 $ sudo -u peertube mkdir config storage versions
  69 ```
  70
  71 Download the latest version of the Peertube client, unzip it and remove the zip
  72 ```
  73 $ cd /var/www/peertube/versions
  74 $ sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip"
  75 $ sudo -u peertube unzip -q peertube-${VERSION}.zip && sudo -u peertube rm peertube-${VERSION}.zip
  76 ```
  77
  78 Install Peertube:
  79 ```
  80 $ cd /var/www/peertube
  81 $ sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
  82 $ cd ./peertube-latest && sudo -H -u peertube yarn install --production --pure-lockfile
  83 ```
  84
  85 ### PeerTube configuration
  86
  87 Copy the default configuration file that contains the default configuration provided by PeerTube.
  88 You **must not** update this file.
  89
  90 ```
  91 $ cd /var/www/peertube
  92 $ sudo -u peertube cp peertube-latest/config/default.yaml config/default.yaml
  93 ```
  94
  95 Now copy the production example configuration:
  96
  97 ```
  98 $ cd /var/www/peertube
  99 $ sudo -u peertube cp peertube-latest/config/production.yaml.example config/production.yaml
 100 ```
 101
 102 Then edit the `config/production.yaml` file according to your webserver
 103 and database configuration (`webserver`, `database`, `redis`, `smtp` and `admin.email` sections in particular).
 104 Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
 105
 106 **PeerTube does not support webserver host change**. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/maintain-tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors.
 107
 108 ### Webserver
 109
 110 We only provide official configuration files for Nginx.
 111
 112 Copy the nginx configuration template:
 113
 114 ```
 115 $ sudo cp /var/www/peertube/peertube-latest/support/nginx/peertube /etc/nginx/sites-available/peertube
 116 ```
 117
 118 Then set the domain for the webserver configuration file.
 119 Replace `[peertube-domain]` with the domain for the peertube server.
 120
 121 ```
 122 $ sudo sed -i 's/${WEBSERVER_HOST}/[peertube-domain]/g' /etc/nginx/sites-available/peertube
 123 $ sudo sed -i 's/${PEERTUBE_HOST}/127.0.0.1:9000/g' /etc/nginx/sites-available/peertube
 124 ```
 125
 126 Then modify the webserver configuration file. Please pay attention to the `alias` keys of the static locations.
 127 It should correspond to the paths of your storage directories (set in the configuration file inside the `storage` key).
 128
 129 ```
 130 $ sudo vim /etc/nginx/sites-available/peertube
 131 ```
 132
 133 Activate the configuration file:
 134
 135 ```
 136 $ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
 137 ```
 138
 139 To generate the certificate for your domain as required to make https work you can use [Let's Encrypt](https://letsencrypt.org/):
 140
 141 ```
 142 $ sudo systemctl stop nginx
 143 $ sudo certbot certonly --standalone --post-hook "systemctl restart nginx"
 144 $ sudo systemctl reload nginx
 145 ```
 146
 147 Now you have the certificates you can reload nginx:
 148
 149 ```
 150 $ sudo systemctl reload nginx
 151 ```
 152
 153 Certbot should have installed a cron to automatically renew your certificate.
 154 Since our nginx template supports webroot renewal, we suggest you to update the renewal config file to use the `webroot` authenticator:
 155
 156 ```
 157 $ # Replace authenticator = standalone by authenticator = webroot
 158 $ # Add webroot_path = /var/www/certbot
 159 $ sudo vim /etc/letsencrypt/renewal/your-domain.com.conf
 160 ```
 161
 162 **FreeBSD**
 163 On FreeBSD you can use [Dehydrated](https://dehydrated.io/) `security/dehydrated` for [Let's Encrypt](https://letsencrypt.org/)
 164
 165 ```
 166 $ sudo pkg install dehydrated
 167 ```
 168
 169 ### TCP/IP Tuning
 170
 171 **On Linux**
 172
 173 ```
 174 $ sudo cp /var/www/peertube/peertube-latest/support/sysctl.d/30-peertube-tcp.conf /etc/sysctl.d/
 175 $ sudo sysctl -p /etc/sysctl.d/30-peertube-tcp.conf
 176 ```
 177
 178 Your distro may enable this by default, but at least Debian 9 does not, and the default FIFO
 179 scheduler is quite prone to "Buffer Bloat" and extreme latency when dealing with slower client
 180 links as we often encounter in a video server.
 181
 182 ### systemd
 183
 184 If your OS uses systemd, copy the configuration template:
 185
 186 ```
 187 $ sudo cp /var/www/peertube/peertube-latest/support/systemd/peertube.service /etc/systemd/system/
 188 ```
 189
 190 Check the service file (PeerTube paths and security directives):
 191
 192 ```
 193 $ sudo vim /etc/systemd/system/peertube.service
 194 ```
 195
 196
 197 Tell systemd to reload its config:
 198
 199 ```
 200 $ sudo systemctl daemon-reload
 201 ```
 202
 203 If you want to start PeerTube on boot:
 204
 205 ```
 206 $ sudo systemctl enable peertube
 207 ```
 208
 209 Run:
 210
 211 ```
 212 $ sudo systemctl start peertube
 213 $ sudo journalctl -feu peertube
 214 ```
 215
 216 **FreeBSD**
 217 On FreeBSD, copy the startup script and update rc.conf:
 218
 219 ```
 220 $ sudo install -m 0555 /var/www/peertube/peertube-latest/support/freebsd/peertube /usr/local/etc/rc.d/
 221 $ sudo sysrc peertube_enable="YES"
 222 ```
 223
 224 Run:
 225
 226 ```
 227 $ sudo service peertube start
 228 ```
 229
 230 ### OpenRC
 231
 232 If your OS uses OpenRC, copy the service script:
 233
 234 ```
 235 $ sudo cp /var/www/peertube/peertube-latest/support/init.d/peertube /etc/init.d/
 236 ```
 237
 238 If you want to start PeerTube on boot:
 239
 240 ```
 241 $ sudo rc-update add peertube default
 242 ```
 243
 244 Run and print last logs:
 245
 246 ```
 247 $ sudo /etc/init.d/peertube start
 248 $ tail -f /var/log/peertube/peertube.log
 249 ```
 250
 251 ### Administrator
 252
 253 The administrator password is automatically generated and can be found in the PeerTube
 254 logs (path defined in `production.yaml`). You can also set another password with:
 255
 256 ```
 257 $ cd /var/www/peertube/peertube-latest && NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u root
 258 ```
 259
 260 Alternatively you can set the environment variable `PT_INITIAL_ROOT_PASSWORD`,
 261 to your own administrator password, although it must be 6 characters or more.
 262
 263 ### What now?
 264
 265 Now your instance is up you can:
 266
 267  * Add your instance to the public PeerTube instances index if you want to: https://instances.joinpeertube.org/
 268  * Check [available CLI tools](/support/doc/tools.md)
 269
 270 ## Upgrade
 271
 272 ### PeerTube instance
 273
 274 **Check the changelog (in particular BREAKING CHANGES!):** https://github.com/Chocobozzz/PeerTube/blob/develop/CHANGELOG.md
 275
 276 #### Auto
 277
 278 The password it asks is PeerTube's database user password.
 279
 280 ```
 281 $ cd /var/www/peertube/peertube-latest/scripts && sudo -H -u peertube ./upgrade.sh
 282 ```
 283
 284 #### Manually
 285
 286 Make a SQL backup
 287
 288 ```
 289 $ SQL_BACKUP_PATH="backup/sql-peertube_prod-$(date -Im).bak" && \
 290     cd /var/www/peertube && sudo -u peertube mkdir -p backup && \
 291     sudo -u postgres pg_dump -F c peertube_prod | sudo -u peertube tee "$SQL_BACKUP_PATH" >/dev/null
 292 ```
 293
 294 Fetch the latest tagged version of Peertube:
 295
 296 ```
 297 $ 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"
 298 ```
 299
 300 Download the new version and unzip it:
 301
 302 ```
 303 $ cd /var/www/peertube/versions && \
 304     sudo -u peertube wget -q "https://github.com/Chocobozzz/PeerTube/releases/download/${VERSION}/peertube-${VERSION}.zip" && \
 305     sudo -u peertube unzip -o peertube-${VERSION}.zip && \
 306     sudo -u peertube rm peertube-${VERSION}.zip
 307 ```
 308
 309 Install node dependencies:
 310
 311 ```
 312 $ cd /var/www/peertube/versions/peertube-${VERSION} && \
 313     sudo -H -u peertube yarn install --production --pure-lockfile
 314 ```
 315
 316 Copy new configuration defaults values and update your configuration file:
 317
 318 ```
 319 $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
 320 $ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
 321 ```
 322
 323 Change the link to point to the latest version:
 324
 325 ```
 326 $ cd /var/www/peertube && \
 327     sudo unlink ./peertube-latest && \
 328     sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
 329 ```
 330
 331 ### nginx
 332
 333 Check changes in nginx configuration:
 334
 335 ```
 336 $ cd /var/www/peertube/versions
 337 $ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
 338 ```
 339
 340 ### systemd
 341
 342 Check changes in systemd configuration:
 343
 344 ```
 345 $ cd /var/www/peertube/versions
 346 $ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
 347 ```
 348
 349 ### Restart PeerTube
 350
 351 If you changed your nginx configuration:
 352
 353 ```
 354 $ sudo systemctl reload nginx
 355 ```
 356
 357 If you changed your systemd configuration:
 358
 359 ```
 360 $ sudo systemctl daemon-reload
 361 ```
 362
 363 Restart PeerTube and check the logs:
 364
 365 ```
 366 $ sudo systemctl restart peertube && sudo journalctl -fu peertube
 367 ```
 368
 369 ### Things went wrong?
 370
 371 Change `peertube-latest` destination to the previous version and restore your SQL backup:
 372
 373 ```
 374 $ OLD_VERSION="v0.42.42" && SQL_BACKUP_PATH="backup/sql-peertube_prod-2018-01-19T10:18+01:00.bak" && \
 375     cd /var/www/peertube && sudo -u peertube unlink ./peertube-latest && \
 376     sudo -u peertube ln -s "versions/peertube-$OLD_VERSION" peertube-latest && \
 377     sudo -u postgres pg_restore -c -C -d postgres "$SQL_BACKUP_PATH" && \
 378     sudo systemctl restart peertube
 379 ```