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