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