X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fdependencies.md;h=8fe1903207391ba304ead1e7db06066ee07907a8;hb=4d557df51c2ad8a87b9789b3caccc95c9880a944;hp=8108466820e8a87ed99104bc1359fc24b47e6217;hpb=a075cd00f37a8d04598c5ec2d61e73a19c39c64d;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/dependencies.md b/support/doc/dependencies.md index 810846682..8fe190320 100644 --- a/support/doc/dependencies.md +++ b/support/doc/dependencies.md @@ -1,16 +1,23 @@ # Dependencies +Follow the below guides, and check their versions match [required external dependencies versions](https://github.com/Chocobozzz/PeerTube/blob/master/engines.yaml). You can check them automatically via `sudo npx engineslist`. + +_note_: only **LTS** versions of external dependencies are supported. If no LTS version matching the version constraint is available, only **release** versions are supported. + - - [Debian / Ubuntu and derivatives](#debian--ubuntu-and-derivatives) - [Arch Linux](#arch-linux) - [CentOS 7](#centos-7) +- [Centos 8](#centos-8) +- [Rocky Linux 8.4](#rocky-linux-84) - [Fedora](#fedora) +- [Red Hat Enterprise Linux 8](#red-hat-enterprise-linux-8) - [FreeBSD](#freebsd) - [macOS](#macos) - [Gentoo](#gentoo) +- [OpenBSD](#openbsd) - [Other distributions](#other-distributions) @@ -25,28 +32,36 @@ 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 10.x: +3. Install NodeJS 14.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) -5. Install yarn, and be sure to have [a recent version](https://github.com/yarnpkg/yarn/releases/latest): +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) -6. Run: +5. Install Python: + +On Ubuntu <= bionic (18.04 LTS) or Debian <= Buster: ``` sudo apt update -sudo apt install nginx ffmpeg postgresql postgresql-contrib openssl g++ make redis-server git python-dev -ffmpeg -version # Should be >= 3.x -g++ -v # Should be >= 5.x +sudo apt install python-dev +python --version # Should be >= 2.x or >= 3.x ``` -If you still have a 2.x version of FFmpeg on Ubuntu: +On Ubuntu >= focal (20.04 LTS) or Debian >= Bullseye: ``` -sudo add-apt-repository ppa:jonathonf/ffmpeg-3 -sudo apt-get update -sudo apt install ffmpeg +sudo apt update +sudo apt install python3-dev python-is-python3 # python-is-python2 should also work +python --version # Should be >= 2.x or >= 3.x +``` + +6. Install common dependencies: + +``` +sudo apt update +sudo apt install certbot nginx ffmpeg postgresql postgresql-contrib openssl g++ make redis-server git cron wget +ffmpeg -version # Should be >= 4.1 +g++ -v # Should be >= 5.x ``` Now that dependencies are installed, before running PeerTube you should start PostgreSQL and Redis: @@ -60,7 +75,7 @@ sudo systemctl start redis postgresql 1. Run: ``` -sudo pacman -S nodejs-lts-dubnium yarn ffmpeg postgresql openssl redis git wget unzip python2 base-devel npm nginx +sudo pacman -S nodejs-lts-fermium yarn ffmpeg postgresql openssl redis git wget unzip python base-devel npm nginx ``` Now that dependencies are installed, before running PeerTube you should start PostgreSQL and Redis: @@ -71,10 +86,10 @@ sudo systemctl start redis postgresql ## CentOS 7 -1. Install NodeJS 10.x: +1. Install NodeJS 12.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: +2. Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install) 3. Install or compile ffmpeg: @@ -82,7 +97,7 @@ sudo systemctl start redis postgresql * 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: +4. Install Packages: ``` sudo yum update @@ -103,13 +118,13 @@ Later when you invoke any node command, please prefix them with `CC=/opt/rh/devt 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: +6. Initialize the PostgreSQL database: ``` -sudo postgresql-setup initdb +sudo PGSETUP_INITDB_OPTIONS='--auth-host=md5' postgresql-setup --initdb --unit postgresql ``` -Now that dependencies are installed, before running PeerTube you should enable and start PostgreSQL and Redis: +Now that dependencies are installed, before running PeerTube you should enable and start PostgreSQL and Redis: ``` sudo systemctl enable --now redis @@ -118,21 +133,21 @@ sudo systemctl enable --now postgresql ## Centos 8 -1. Install NodeJS 10.x: +1. Install NodeJS 12.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: +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: +4. Install packages: ``` sudo dnf update -sudo dnf install epel-release +sudo dnf install epel-release sudo dnf update sudo dnf install nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git ``` @@ -143,19 +158,64 @@ sudo dnf install nginx postgresql postgresql-server postgresql-contrib openssl g sudo ln -s /usr/bin/python3 /usr/bin/python ``` -6. Initialize the PostgreSQL database: +6. Initialize the PostgreSQL database: + +``` +sudo PGSETUP_INITDB_OPTIONS='--auth-host=md5' postgresql-setup --initdb --unit postgresql +``` + +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 +``` + +## Rocky Linux 8.4 + +1. Pull the latest updates: +``` +sudo dnf update -y +``` +2. Install NodeJS 12.x (or 14): ``` -sudo postgresql-setup initdb +sudo dnf module install -y nodejs:12 ``` -Now that dependencies are installed, before running PeerTube you should enable and start PostgreSQL and Redis: +3. Install yarn: +``` +sudo npm install --global yarn +``` +4. Install or compile ffmpeg (if you want to compile... enjoy): +``` +sudo dnf install -y epel-release +sudo dnf --enablerepo=powertools install -y SDL2 SDL2-devel +sudo dnf install -y --nogpgcheck https://download1.rpmfusion.org/free/el/rpmfusion-free-release-8.noarch.rpm https://download1.rpmfusion.org/nonfree/el/rpmfusion-nonfree-release-8.noarch.rpm +sudo dnf install -y ffmpeg +sudo dnf update -y ``` + +5. Install PostgreSQL and Python3 and other stuff: +``` +sudo dnf install -y nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git python3 +sudo ln -s /usr/bin/python3 /usr/bin/python +sudo PGSETUP_INITDB_OPTIONS='--auth-host=md5' postgresql-setup --initdb --unit postgresql sudo systemctl enable --now redis sudo systemctl enable --now postgresql ``` +6. Configure the peertube user: +``` +sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube +``` + +7. Unknown missing steps: +- Steps missing here... these were adapted from the CentOS 8 steps which abruptly ended. +- /var/www/peertube does not exist yet (expected? done in future steps? documentation?). +- Nothing about Certbot, NGINX, Firewall settings, and etc. +- Hopefully someone can suggest what is missing here with some hints so I can add it? ## Fedora @@ -174,13 +234,13 @@ usermod my-peertube-user -a -G wheel # Add my-peertube-user to sudoers su my-peertube-user ``` -3. (Optional) Install certbot (choose instructions for nginx and your distribution): +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: +4. Install NodeJS 12.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: +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) @@ -193,19 +253,27 @@ 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 >= 3.x +sudo dnf install nginx ffmpeg postgresql-server postgresql-contrib openssl gcc-c++ make redis git vim +ffmpeg -version # Should be >= 4.1 g++ -v # Should be >= 5.x ``` -8. Post-installation +8. Configure nginx + +``` +sudo mkdir /etc/nginx/sites-available +sudo mkdir /etc/nginx/sites-enabled +sudo ln -s /etc/nginx/sites-enabled/peertube /etc/nginx/conf.d/peertube.conf +``` + +9. 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 PGSETUP_INITDB_OPTIONS='--auth-host=md5' postgresql-setup --initdb --unit postgresql sudo systemctl enable postgresql.service sudo systemctl start postgresql.service # Nginx @@ -216,24 +284,31 @@ sudo systemctl enable redis.service sudo systemctl start redis.service ``` -9. Firewall +10. Firewall By default, you cannot access your server via public IP. To do so, you must configure firewall: +- Ports used by peertube dev setup: ``` -# 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 +``` +- Optional + +``` sudo firewall-cmd --permanent --zone=public --add-service=http sudo firewall-cmd --permanent --zone=public --add-service=https -# Reload firewall +``` + +- Reload firewall + +``` sudo firewall-cmd --reload ``` -10. Configure max ports +11. Configure max ports -This is necessary if you are running dev setup, otherwise you will have errors with `nodemon` +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 @@ -241,31 +316,146 @@ echo fs.inotify.max_user_watches=582222 | sudo tee -a /etc/sysctl.conf && sudo s [More info](https://stackoverflow.com/questions/34662574/node-js-getting-error-nodemon-internal-watch-failed-watch-enospc#34664097) +## Red Hat Enterprise Linux 8 + +1. Register system as root user to Red Hat Subscription Management (create a free Red Hat account if you don't have one yet). + +``` +# subscription-manager register --username --password --auto-attach +# dnf upgrade +# reboot +``` + +2. Install Node.JS + +``` +sudo dnf module install nodejs:12 +``` + +3. Install Yarn + +``` +curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo +sudo dnf install yarn +``` + +4. Install FFmpeg + +``` +sudo subscription-manager repos --enable "codeready-builder-for-rhel-8-$(arch)-rpms" +sudo dnf install --nogpgcheck https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm +sudo dnf install --nogpgcheck https://mirrors.rpmfusion.org/free/el/rpmfusion-free-release-8.noarch.rpm +sudo dnf upgrade +sudo dnf install ffmpeg +``` + +5. Run: + +``` +sudo dnf install nginx postgresql postgresql-server postgresql-contrib openssl gcc-c++ make wget redis git +``` + +6. You'll need a symlink for python3 to python for youtube-dl to work + +``` +sudo ln -s /usr/bin/python3 /usr/bin/python +``` + +7. Initialize the PostgreSQL database: + +``` +sudo PGSETUP_INITDB_OPTIONS='--auth-host=md5' postgresql-setup --initdb --unit postgresql +``` + +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 +``` + +If you are running the production guide, you also need to slightly pre-configure nginx, because nginx is packaged differently in the Red Hat family distributions: + +8. Configure nginx + +``` +sudo mkdir /etc/nginx/sites-available +sudo mkdir /etc/nginx/sites-enabled +sudo ln -s /etc/nginx/sites-enabled/peertube /etc/nginx/conf.d/peertube.conf +sudo systemctl enable --now nginx +``` + +9. Prepare directory + +To add the 'peertube' user, you first have to create the 'www' folder and once the 'peertube' user is added, you have to set the access permissions. + +``` +sudo mkdir /var/www + +sudo useradd -m -d /var/www/peertube -s /bin/bash -p peertube peertube +sudo passwd peertube + +sudo chmod 755 /var/www/peertube/ +``` + +10. 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 +``` + +11. 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): +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 +pkg install -y sudo bash wget git python nginx pkgconf postgresql13-server postgresql13-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. +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 - + ``` %wheel ALL=(ALL) ALL ``` -3. Enable nginx, redis, postgresql services and initialize database. +3. Enable nginx, redis, postgresql services and initialize database. ``` sysrc postgresql_enable="YES" @@ -286,17 +476,34 @@ service nginx start 1. Add the packages: +```sh +brew install bash ffmpeg nginx postgresql openssl gcc make redis git yarn ``` -brew install ffmpeg nginx postgresql openssl gcc make redis git yarn + +You may need to update your default version of bash. + +**How to change your default shell** + +```sh +which -a bash # Check where bash is installed +bash --version # You need a version at least as recent as 4.0 +sudo vim /etc/shells # Add in this file : /usr/local/bin/bash +chsh -s /usr/local/bin/bash # To set the brew-installed bash as default bash ``` +In a new shell, type `bash --version` to assert your changes took effect and +correctly modified your default bash version. + 2. Run the services: -``` +```sh brew services run postgresql brew services run redis ``` +On macOS, the `postgresql` user can be `_postgres` instead of `postgres`. +If `sudo -u postgres createuser -P peertube` gives you an `unknown user: postgres` error, you can try `sudo -u _postgres createuser -U peertube`. + ## Gentoo 1. Add this to ``/etc/portage/sets/peertube``: @@ -309,12 +516,11 @@ dev-db/postgresql dev-db/redis dev-vcs/git app-arch/unzip -dev-lang/python:2.7 +dev-lang/python www-servers/nginx # Optional, client for Let’s Encrypt: # app-crypt/certbot -# app-crypt/certbot-nginx ``` 2. If you are on a "stable" Gentoo you need to accept the testing keyword ~amd64 yarn: @@ -347,7 +553,38 @@ rc-update add postgresql-11 rc-service redis start rc-service postgresql-11 start ``` - + +## OpenBSD + +1. Install Packages: + +``` +pkg_add sudo bash wget git python nginx pkgconf postgresql-server postgresql-contrib redis openssl +``` + +2. Install yarn: + +``` +npm install --global yarn +``` + +3. Allow users in the wheel group to use sudo + +``` +visudo +``` +Uncomment line #43: + +``` +%wheel ALL=(ALL) ALL +``` + +4. Enable services: + +``` +rcctl enable postgresql redis nginx +``` + ## Other distributions Feel free to update this file in a pull request!