support/doc/dependencies.md

   1 # Dependencies
   2
   3 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
   4 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
   5
   6
   7 - [Debian / Ubuntu and derivatives](#debian--ubuntu-and-derivatives)
   8 - [Arch Linux](#arch-linux)
   9 - [CentOS 7](#centos-7)
  10 - [Fedora](#fedora)
  11 - [FreeBSD](#freebsd)
  12 - [macOS](#macos)
  13 - [Gentoo](#gentoo)
  14 - [Other distributions](#other-distributions)
  15
  16 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
  17
  18 ## Debian / Ubuntu and derivatives
  19
  20 1. On a fresh Debian/Ubuntu, as root user, install basic utility programs needed for the installation
  21
  22 ```
  23 # apt-get install curl sudo unzip vim
  24 ```
  25
  26 2. It would be wise to disable root access and to continue this tutorial with a user with sudoers group access
  27
  28 3. Install certbot (choose instructions for nginx and your distribution) :
  29 [https://certbot.eff.org/all-instructions](https://certbot.eff.org/all-instructions)
  30 4. Install NodeJS 10.x:
  31 [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
  32 5. Install yarn, and be sure to have [a recent version](https://github.com/yarnpkg/yarn/releases/latest):
  33 [https://yarnpkg.com/en/docs/install#linux-tab](https://yarnpkg.com/en/docs/install#linux-tab)
  34
  35 6. Run:
  36
  37 ```
  38 sudo apt update
  39 sudo apt install nginx ffmpeg postgresql postgresql-contrib openssl g++ make redis-server git python-dev
  40 ffmpeg -version # Should be >= 3.x
  41 g++ -v # Should be >= 5.x
  42 ```
  43
  44 If you still have a 2.x version of FFmpeg on Ubuntu:
  45
  46 ```
  47 sudo add-apt-repository ppa:jonathonf/ffmpeg-3
  48 sudo apt-get update
  49 sudo apt install ffmpeg
  50 ```
  51
  52 Now that dependencies are installed, before running PeerTube you should start PostgreSQL and Redis:
  53
  54 ```
  55 sudo systemctl start redis postgresql
  56 ```
  57
  58 ## Arch Linux
  59
  60 1. Run:
  61
  62 ```
  63 sudo pacman -S nodejs-lts-dubnium yarn ffmpeg postgresql openssl redis git wget unzip python2 base-devel npm nginx
  64 ```
  65
  66 Now that dependencies are installed, before running PeerTube you should start PostgreSQL and Redis:
  67
  68 ```
  69 sudo systemctl start redis postgresql
  70 ```
  71
  72 ## CentOS 7
  73
  74 1. Install NodeJS 10.x:
  75 [https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora](https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora)
  76
  77 2. Install yarn:
  78 [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
  79
  80 3. Install or compile ffmpeg:
  81
  82 * Install - [https://linoxide.com/linux-how-to/install-ffmpeg-centos-7/](https://linoxide.com/linux-how-to/install-ffmpeg-centos-7/)
  83 * Compile - [https://gist.github.com/mustafaturan/7053900#file-latest-ffmpeg-centos6-sh](https://gist.github.com/mustafaturan/7053900#file-latest-ffmpeg-centos6-sh)
  84
  85 4. Install Packages:
  86
  87 ```
  88 sudo yum update
  89 sudo yum install epel-release centos-release-scl
  90 sudo yum update
  91 sudo yum install nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git devtoolset-7
  92 ```
  93
  94 5. You need to use a more up to date version of G++ in order to run the yarn install command, hence the installation of devtoolset-7.
  95
  96 ```
  97 sudo scl enable devtoolset-7 bash
  98 ```
  99
 100 Later when you invoke any node command, please prefix them with `CC=/opt/rh/devtoolset-7/root/usr/bin/gcc CXX=/opt/rh/devtoolset-7/root/usr/bin/g++`, such as with:
 101
 102 ```
 103 sudo -H -u peertube CC=/opt/rh/devtoolset-7/root/usr/bin/gcc CXX=/opt/rh/devtoolset-7/root/usr/bin/g++ yarn install --production --pure-lockfile
 104 ```
 105
 106 6. Initialize the PostgreSQL database:
 107
 108 ```
 109 sudo postgresql-setup initdb
 110 ```
 111
 112 Now that dependencies are installed, before running PeerTube you should enable and start PostgreSQL and Redis:
 113
 114 ```
 115 sudo systemctl enable --now redis
 116 sudo systemctl enable --now postgresql
 117 ```
 118
 119 ## Centos 8
 120
 121 1. Install NodeJS 10.x:
 122 [https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora](https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora)
 123
 124 2. Install yarn:
 125 [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
 126
 127 3. Install or compile ffmpeg:
 128
 129 * Install - [https://linuxize.com/post/how-to-install-ffmpeg-on-centos-8/](https://linuxize.com/post/how-to-install-ffmpeg-on-centos-8/)
 130
 131 4. Install packages:
 132
 133 ```
 134 sudo dnf update
 135 sudo dnf install epel-release
 136 sudo dnf update
 137 sudo dnf install nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git
 138 ```
 139
 140 5. You'll need a symlink for python3 to python for youtube-dl to work
 141
 142 ```
 143 sudo ln -s /usr/bin/python3 /usr/bin/python
 144 ```
 145
 146 6. Initialize the PostgreSQL database:
 147
 148 ```
 149 sudo postgresql-setup initdb
 150 ```
 151
 152 Now that dependencies are installed, before running PeerTube you should enable and start PostgreSQL and Redis:
 153
 154 ```
 155 sudo systemctl enable --now redis
 156 sudo systemctl enable --now postgresql
 157 ```
 158
 159
 160 ## Fedora
 161
 162 1. Upgrade your packages:
 163
 164 ```
 165 dnf upgrade
 166 ```
 167
 168 2. Add a user with sudoers group access:
 169
 170 ```
 171 useradd my-peertube-user
 172 passwd my-peertube-user
 173 usermod my-peertube-user -a -G wheel    # Add my-peertube-user to sudoers
 174 su my-peertube-user
 175 ```
 176
 177 3. (Optional) Install certbot (choose instructions for nginx and your distribution):
 178 [https://certbot.eff.org/all-instructions](https://certbot.eff.org/all-instructions)
 179
 180 4. Install NodeJS 10.x:
 181 [https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora](https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora)
 182
 183 5. Install yarn:
 184 [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
 185
 186 6. Enable [RPM Fusion](https://rpmfusion.org) for Fedora (available for x86, x86_64, armhfp)
 187
 188 ```
 189 sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
 190 ```
 191 This is necessary because `ffmpeg` is not in the Fedora repos.
 192
 193 7. Run:
 194
 195 ```
 196 sudo dnf install nginx ffmpeg postgresql-server postgresql-contrib openssl gcc-c++ make redis git
 197 ffmpeg -version # Should be >= 3.x
 198 g++ -v # Should be >= 5.x
 199 ```
 200
 201 8. Post-installation
 202
 203 _from [PostgreSQL documentation](https://www.postgresql.org/download/linux/redhat/):_
 204 > Due to policies for Red Hat family distributions, the PostgreSQL installation will not be enabled for automatic start or have the database initialized automatically.
 205
 206 ```
 207 # PostgreSQL
 208 sudo postgresql-setup initdb
 209 sudo systemctl enable postgresql.service
 210 sudo systemctl start postgresql.service
 211 # Nginx
 212 sudo systemctl enable nginx.service
 213 sudo systemctl start nginx.service
 214 # Redis
 215 sudo systemctl enable redis.service
 216 sudo systemctl start redis.service
 217 ```
 218
 219 9. Firewall
 220
 221 By default, you cannot access your server via public IP. To do so, you must configure firewall:
 222
 223 ```
 224 # Ports used by peertube dev setup
 225 sudo firewall-cmd --permanent --zone=public --add-port=3000/tcp
 226 sudo firewall-cmd --permanent --zone=public --add-port=9000/tcp
 227 # Optional
 228 sudo firewall-cmd --permanent --zone=public --add-service=http
 229 sudo firewall-cmd --permanent --zone=public --add-service=https
 230 # Reload firewall
 231 sudo firewall-cmd --reload
 232 ```
 233
 234 10. Configure max ports
 235
 236 This is necessary if you are running dev setup, otherwise you will have errors with `nodemon`
 237
 238 ```
 239 echo fs.inotify.max_user_watches=582222 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
 240 ```
 241
 242 [More info](https://stackoverflow.com/questions/34662574/node-js-getting-error-nodemon-internal-watch-failed-watch-enospc#34664097)
 243
 244 ## FreeBSD
 245
 246 On a fresh install of [FreeBSD](https://www.freebsd.org), new system or new jail:
 247
 248 1. bootstrap pkg, initialize db and install peertube's dependencies, always as root (sudo not yet installed):
 249
 250 ```
 251 pkg
 252 pkg update
 253 pkg install -y sudo bash wget git python nginx pkgconf vips postgresql96-server postgresql96-contrib redis openssl node npm yarn ffmpeg unzip
 254 ```
 255
 256 2. Allow users in the wheel group (hope you don't forgot to add your user on wheel group!) to use sudo.
 257
 258 ```
 259 # visudo
 260 ```
 261
 262 Uncomment the line 90
 263
 264 ```
 265 %wheel ALL=(ALL) ALL
 266 ```
 267
 268 3. Enable nginx, redis, postgresql services and initialize database.
 269
 270 ```
 271 sysrc postgresql_enable="YES"
 272 sysrc redis_enable="YES"
 273 sysrc nginx_enable="YES"
 274 ```
 275
 276 Initialize database and start services
 277
 278 ```
 279 service postgresql initdb
 280 service postgresql start
 281 service redis start
 282 service nginx start
 283 ```
 284
 285 ## macOS
 286
 287 1. Add the packages:
 288
 289 ```
 290 brew install ffmpeg nginx postgresql openssl gcc make redis git yarn
 291 ```
 292
 293 2. Run the services:
 294
 295 ```
 296 brew services run postgresql
 297 brew services run redis
 298 ```
 299
 300 ## Gentoo
 301
 302 1. Add this to ``/etc/portage/sets/peertube``:
 303
 304 ```
 305 net-libs/nodejs
 306 sys-apps/yarn
 307 media-video/ffmpeg[x264] # Optionnally add vorbis,vpx
 308 dev-db/postgresql
 309 dev-db/redis
 310 dev-vcs/git
 311 app-arch/unzip
 312 dev-lang/python:2.7
 313 www-servers/nginx
 314
 315 # Optional, client for Let’s Encrypt:
 316 # app-crypt/certbot
 317 # app-crypt/certbot-nginx
 318 ```
 319
 320 2. If you are on a "stable" Gentoo you need to accept the testing keyword ~amd64 yarn:
 321
 322 ```
 323 mkdir -p /etc/portage/package.keywords
 324 cat << EOF >> /etc/portage/package.keywords/peertube
 325 # required by yarn (argument) for PeerTube
 326 sys-apps/yarn ~amd64
 327 EOF
 328 ```
 329
 330 3. Compile the peertube set:
 331
 332 ```
 333 emerge -a @peertube
 334 ```
 335
 336 4. Initialize the PostgreSQL database if you just merged it:
 337
 338 ```
 339 emerge --config postgresql
 340 ```
 341
 342 5. (For OpenRC) Enable and then start the services (replace with the correct PostgreSQL slot):
 343
 344 ```
 345 rc-update add redis
 346 rc-update add postgresql-11
 347 rc-service redis start
 348 rc-service postgresql-11 start
 349 ```
 350
 351 ## Other distributions
 352
 353 Feel free to update this file in a pull request!