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