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