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