X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fdependencies.md;h=61f8b7f367a0ace9ea30b74232fac39164828cb7;hb=69e0e678beb7f1a3b6753eeff585a14f9a61ea86;hp=52b53fdbe644b7e299f5a506ff4c6c82129e3629;hpb=c50480a359572b28888489eb41ad819f716d2573;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/support/doc/dependencies.md b/support/doc/dependencies.md
index 52b53fdbe..61f8b7f36 100644
--- a/support/doc/dependencies.md
+++ b/support/doc/dependencies.md
@@ -1,121 +1,343 @@
 # Dependencies
 
+Follow the below guides, and check their versions match [required external dependencies versions](https://github.com/Chocobozzz/PeerTube/blob/master/package.json#7). You can check them automatically via `sudo npx engineslist`.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Debian / Ubuntu and derivatives](#debian--ubuntu-and-derivatives)
+- [Arch Linux](#arch-linux)
+- [CentOS 7](#centos-7)
+- [CentOS 8](#centos-8)
+- [Fedora](#fedora)
+- [FreeBSD](#freebsd)
+- [macOS](#macos)
+- [Gentoo](#gentoo)
+- [Other distributions](#other-distributions)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Debian / Ubuntu and derivatives
-  1. On a fresh Debian/Ubuntu, as root user, install basic utility programs needed for the installation
+
+1. On a fresh Debian/Ubuntu, as root user, install basic utility programs needed for the installation
 
 ```
 # apt-get install curl sudo unzip vim
 ```
 
-  2. It would be wise to disable root access and to continue this tutorial with a user with sudoers group access
+2. It would be wise to disable root access and to continue this tutorial with a user with sudoers group access
 
-  3. Install certbot (choose instructions for nginx and your distribution) :
-     [https://certbot.eff.org/all-instructions](https://certbot.eff.org/all-instructions)
-  4. Install NodeJS 8.x (current LTS):
-     [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)
-  5. Install yarn:
-     [https://yarnpkg.com/en/docs/install#linux-tab](https://yarnpkg.com/en/docs/install#linux-tab)
-  6. Run:
+3. Install NodeJS 10.x:
+[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)
+4. Install yarn, and be sure to have [a recent version](https://github.com/yarnpkg/yarn/releases/latest):
+[https://yarnpkg.com/en/docs/install#linux-tab](https://yarnpkg.com/en/docs/install#linux-tab)
+
+5. Run:
 
 ```
-$ sudo apt update
-$ sudo apt install nginx ffmpeg postgresql openssl g++ make redis-server git
-$ ffmpeg -version # Should be >= 3.x
-$ g++ -v # Should be >= 5.x
+sudo apt update
+sudo apt install certbot nginx ffmpeg postgresql postgresql-contrib openssl g++ make redis-server git python-dev
+ffmpeg -version # Should be >= 4.1
+g++ -v # Should be >= 5.x
 ```
 
-If you still have a 2.x version of FFmpeg on Ubuntu:
+Now that dependencies are installed, before running PeerTube you should start PostgreSQL and Redis:
+
 ```
-$ sudo add-apt-repository ppa:jonathonf/ffmpeg-3
-$ sudo apt-get update
-$ sudo apt install ffmpeg
+sudo systemctl start redis postgresql
 ```
 
 ## Arch Linux
 
-  1. Run:
+1. Run:
 
 ```
-$ sudo pacman -S nodejs yarn ffmpeg postgresql openssl redis git wget unzip python2 base-devel npm nginx
+sudo pacman -S nodejs-lts-dubnium yarn ffmpeg postgresql openssl redis git wget unzip python2 base-devel npm nginx
+```
+
+Now that dependencies are installed, before running PeerTube you should start PostgreSQL and Redis:
+
+```
+sudo systemctl start redis postgresql
 ```
 
 ## CentOS 7
 
-  1. Install NodeJS 8.x (current LTS):
-     [https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora](https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora)
-  2. Install yarn:
-     [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
-  3. Install or compile ffmpeg:
-     * Install - [https://linoxide.com/linux-how-to/install-ffmpeg-centos-7/](https://linoxide.com/linux-how-to/install-ffmpeg-centos-7/)
-     * Compile - [https://gist.github.com/mustafaturan/7053900#file-latest-ffmpeg-centos6-sh](https://gist.github.com/mustafaturan/7053900#file-latest-ffmpeg-centos6-sh)
-  4. Run:
+1. Install NodeJS 10.x:
+[https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora](https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora)
+
+2. Install yarn:
+[https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
+
+3. Install or compile ffmpeg:
+
+* Install - [https://linoxide.com/linux-how-to/install-ffmpeg-centos-7/](https://linoxide.com/linux-how-to/install-ffmpeg-centos-7/)
+* Compile - [https://gist.github.com/mustafaturan/7053900#file-latest-ffmpeg-centos6-sh](https://gist.github.com/mustafaturan/7053900#file-latest-ffmpeg-centos6-sh)
+
+4. Install Packages:
 
 ```
-$ sudo yum update
-$ sudo yum install epel-release centos-release-scl
-$ sudo yum update
-$ sudo yum install nginx postgresql postgresql-server openssl gcc-c++ make redis git devtoolset-6
+sudo yum update
+sudo yum install epel-release centos-release-scl
+sudo yum update
+sudo yum install nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git devtoolset-7
 ```
 
-  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-6.
+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.
+
 ```
-$ sudo scl devtoolset-6 bash
+sudo scl enable devtoolset-7 bash
 ```
 
-## FreeBSD
+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:
 
-On a fresh install of [FreeBSD](https://www.freebsd.org), new system or new jail:
+```
+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
+```
+
+6. Initialize the PostgreSQL database:
+
+```
+sudo postgresql-setup initdb
+```
+
+Now that dependencies are installed, before running PeerTube you should enable and start PostgreSQL and Redis:
+
+```
+sudo systemctl enable --now redis
+sudo systemctl enable --now postgresql
+```
+
+## Centos 8
+
+1. Install NodeJS 10.x:
+[https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora](https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora)
+
+2. Install yarn:
+[https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
+
+3. Install or compile ffmpeg:
+
+* Install - [https://linuxize.com/post/how-to-install-ffmpeg-on-centos-8/](https://linuxize.com/post/how-to-install-ffmpeg-on-centos-8/)
+
+4. Install packages:
 
-  1. edit `/etc/pkg/FreeBSD.conf` to use latest instead quaterly (installation was tested with the latest repository), as root:
 ```
-# ee /etc/pkg/FreeBSD.conf
+sudo dnf update
+sudo dnf install epel-release
+sudo dnf update
+sudo dnf install nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git
 ```
 
-     change this line (11):
+5. You'll need a symlink for python3 to python for youtube-dl to work
+
 ```
-  url: "pkg+http://pkg.FreeBSD.org/${ABI}/quaterly",
+sudo ln -s /usr/bin/python3 /usr/bin/python
 ```
 
-     to:
+6. Initialize the PostgreSQL database:
+
 ```
-  url: "pkg+http://pkg.FreeBSD.org/${ABI}/latest",
+sudo postgresql-setup initdb
 ```
 
-  2. bootsrap pkg, initialize db and install peertube's dependencies, always as root (sudo not yet installed):
+Now that dependencies are installed, before running PeerTube you should enable and start PostgreSQL and Redis:
+
 ```
-# pkg
-# pkg update
-# pkg install -y sudo bash wget git python nginx pkgconf vips postgresql96-server redis openssl node npm yarn ffmpeg unzip
+sudo systemctl enable --now redis
+sudo systemctl enable --now postgresql
 ```
 
-  3. Allow users in the wheel group (hope you don't forgot to add your user on wheel group!) to use sudo
+
+## Fedora
+
+1. Upgrade your packages:
+
+```
+dnf upgrade
+```
+
+2. Add a user with sudoers group access:
+
+```
+useradd my-peertube-user
+passwd my-peertube-user
+usermod my-peertube-user -a -G wheel	# Add my-peertube-user to sudoers
+su my-peertube-user
+```
+
+3. (Optional) Install certbot (choose instructions for your distribution):
+[https://certbot.eff.org/all-instructions](https://certbot.eff.org/all-instructions)
+
+4. Install NodeJS 10.x:
+[https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora](https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora)
+
+5. Install yarn:
+[https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
+
+6. Enable [RPM Fusion](https://rpmfusion.org) for Fedora (available for x86, x86_64, armhfp)
+
+```
+sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
+```
+This is necessary because `ffmpeg` is not in the Fedora repos.
+
+7. Run:
+
+```
+sudo dnf install nginx ffmpeg postgresql-server postgresql-contrib openssl gcc-c++ make redis git
+ffmpeg -version # Should be >= 4.1
+g++ -v # Should be >= 5.x
+```
+
+8. Post-installation
+
+_from [PostgreSQL documentation](https://www.postgresql.org/download/linux/redhat/):_
+> Due to policies for Red Hat family distributions, the PostgreSQL installation will not be enabled for automatic start or have the database initialized automatically.
+
+```
+# PostgreSQL
+sudo postgresql-setup initdb
+sudo systemctl enable postgresql.service
+sudo systemctl start postgresql.service
+# Nginx
+sudo systemctl enable nginx.service
+sudo systemctl start nginx.service
+# Redis
+sudo systemctl enable redis.service
+sudo systemctl start redis.service
+```
+
+9. Firewall
+
+By default, you cannot access your server via public IP. To do so, you must configure firewall:
+
+```
+# Ports used by peertube dev setup
+sudo firewall-cmd --permanent --zone=public --add-port=3000/tcp
+sudo firewall-cmd --permanent --zone=public --add-port=9000/tcp
+# Optional
+sudo firewall-cmd --permanent --zone=public --add-service=http
+sudo firewall-cmd --permanent --zone=public --add-service=https
+# Reload firewall
+sudo firewall-cmd --reload
+```
+
+10. Configure max ports
+
+This is necessary if you are running dev setup, otherwise you will have errors with `nodemon`
+
+```
+echo fs.inotify.max_user_watches=582222 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
+```
+
+[More info](https://stackoverflow.com/questions/34662574/node-js-getting-error-nodemon-internal-watch-failed-watch-enospc#34664097)
+
+## FreeBSD
+
+On a fresh install of [FreeBSD](https://www.freebsd.org), new system or new jail:
+
+1. bootstrap pkg, initialize db and install peertube's dependencies, always as root (sudo not yet installed):
+
+```
+pkg
+pkg update
+pkg install -y sudo bash wget git python nginx pkgconf vips postgresql96-server postgresql96-contrib redis openssl node npm yarn ffmpeg unzip
+```
+
+2. Allow users in the wheel group (hope you don't forgot to add your user on wheel group!) to use sudo.
+
 ```
 # visudo
 ```
 
-     Uncomment the line 90
+Uncomment the line 90
+
 ```
 %wheel ALL=(ALL) ALL
 ```
 
-  4. Enable nginx, redis, postgresql services and initialize database
+3. Enable nginx, redis, postgresql services and initialize database.
+
 ```
-# ee /etc/rc.conf
+sysrc postgresql_enable="YES"
+sysrc redis_enable="YES"
+sysrc nginx_enable="YES"
 ```
 
-     Add the following lines
+Initialize database and start services
+
 ```
-postgresql_enable="YES"
-redis_enable="YES"
-nginx_enable="YES"
+service postgresql initdb
+service postgresql start
+service redis start
+service nginx start
 ```
 
-	 Initialize database and start services
+## macOS
+
+1. Add the packages:
+
+```
+brew install ffmpeg nginx postgresql openssl gcc make redis git yarn
+```
+
+2. Run the services:
+
+```
+brew services run postgresql
+brew services run redis
+```
+
+## Gentoo
+
+1. Add this to ``/etc/portage/sets/peertube``:
+
+```
+net-libs/nodejs
+sys-apps/yarn
+media-video/ffmpeg[x264] # Optionnally add vorbis,vpx
+dev-db/postgresql
+dev-db/redis
+dev-vcs/git
+app-arch/unzip
+dev-lang/python:2.7
+www-servers/nginx
+
+# Optional, client for Let’s Encrypt:
+# app-crypt/certbot
+```
+
+2. If you are on a "stable" Gentoo you need to accept the testing keyword ~amd64 yarn:
+
+```
+mkdir -p /etc/portage/package.keywords
+cat << EOF >> /etc/portage/package.keywords/peertube
+# required by yarn (argument) for PeerTube
+sys-apps/yarn ~amd64
+EOF
+```
+
+3. Compile the peertube set:
+
+```
+emerge -a @peertube
+```
+
+4. Initialize the PostgreSQL database if you just merged it:
+
+```
+emerge --config postgresql
+```
+
+5. (For OpenRC) Enable and then start the services (replace with the correct PostgreSQL slot):
+
 ```
-# service postgresql initdb
-# service postgresql start
-# service redis start
-# service nginx start
+rc-update add redis
+rc-update add postgresql-11
+rc-service redis start
+rc-service postgresql-11 start
 ```
 
 ## Other distributions