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