diff --git a/docs/installation-development.md b/docs/installation-development.md index 04f4be964427eea3c45833a468d305d6e7c9353d..8dc2d174de4b8177d2dffae798d0df25d053a2bb 100644 --- a/docs/installation-development.md +++ b/docs/installation-development.md @@ -30,7 +30,9 @@ sudo apt-get install \ libsndfile1 \ ffmpeg \ quelcom \ - python3-pip + python3-pip \ + virtualenv \ + libfaac-dev ``` Depending on the database management system you gonna use, you'll also need to install those packages. @@ -45,17 +47,14 @@ sudo apt-get install \ libmariadbclient-dev ``` -**Install Liquidsoap** +**Liquidsoap Repository** -Now it's time to install the Liquidsoap and its dependencies. +Engine requires at least `Liquidsoap 1.4.1` or newer, installed using [OPAM (OCaml Package Manager)](https://opam.ocaml.org/). -Install `Liquidsoap 1.4.1` or newer, using [OPAM](https://www.liquidsoap.info/doc-1.4.1/install.html). +Add the current Liquidsoap repository from [this installation guide](https://www.liquidsoap.info/doc-1.4.1/install.html). -Let's initialize OPAM for the user you are going to run the engine with: - -```bash - opam init -``` +The other steps required for the Liquidsoap installation are handled by the `install.sh` script. If you experience any +errors, carefully review them and consult the official documentation for installing Liquidsoap. ## Setup Database diff --git a/docs/installation-production.md b/docs/installation-production.md index bf744b23f73abd5bb38f7df900a20051a0de732b..f4538b73e12d4fe98308c5b2b375fc417bc7a454 100644 --- a/docs/installation-production.md +++ b/docs/installation-production.md @@ -21,9 +21,24 @@ Aura Engine runs on any modern Debian-based OS. It requires at least - `Python 3.7` - `git` -Additionally you'll need these system packages: +Additionally you'll need these system packages below. + +Some packages may require *Non-Free* (Debian) or *Multiverse* (Ubuntu) Repository support. One of these +packages is `libfaac-dev`. Therefor edit your `/etc/apt/sources.list` and add `contrib non-free` in case of Debian: + +``` +deb http://ftp.at.debian.org/debian/ buster main contrib non-free +``` + +In case of Ubuntu you can add Universe and Multiverse support by: + +```shell +sudo add-apt-repository universe +sudo add-apt-repository multiverse +``` ```shell +sudo apt-get update sudo apt-get install \ supervisor \ opam \ @@ -32,9 +47,12 @@ sudo apt-get install \ ffmpeg \ quelcom \ python3-pip \ - virtualenv + virtualenv \ + libfaac-dev ``` + + Depending on the database management system you gonna use, you'll also need to install those packages. In case of MariaDB this is: @@ -64,31 +82,14 @@ And switch to that user su engineuser ``` -**Install Liquidsoap** - -Install at least `Liquidsoap 1.4.1` or newer, using [OPAM (OCaml Package Manager)](https://opam.ocaml.org/). - -Follow [this installation guide](https://www.liquidsoap.info/doc-1.4.1/install.html) or the summarized steps below. +**Liquidsoap Repository** -1. Let's initialize OPAM for the user you are going to run the engine with: +Engine requires at least `Liquidsoap 1.4.1` or newer, installed using [OPAM (OCaml Package Manager)](https://opam.ocaml.org/). -```shell - engineuser:$ opam init -y -``` - -2. Ensure to have at least the OCaml version v4.08.0 - -```shell - engineuser:$ opam switch create 4.08.0 -``` - -3. Update the current shell environment - - -```shell - engineuser:$ eval $(opam env) -``` +Add the current Liquidsoap repository from [this installation guide](https://www.liquidsoap.info/doc-1.4.1/install.html). +The other steps required for the Liquidsoap installation are handled by the `install.sh` script. If you experience any +errors, carefully review them and consult the official documentation for installing Liquidsoap. **Cloning the project** diff --git a/install.sh b/install.sh index ddf711a87a3b9987381ecd9de36dc7a904044016..5a6ca483b64126272fd0b40e94cb2167970e4c2c 100755 --- a/install.sh +++ b/install.sh @@ -16,7 +16,7 @@ fi # Development and Production -echo "Installation OPAM Packages ..." +echo "Installing OPAM Packages ..." bash script/install-opam-packages.sh echo "Installing Python Requirements ..." diff --git a/script/install-opam-packages.sh b/script/install-opam-packages.sh index 1844c0ebfddbed3290fe22896e6c8b97670e60a1..ff9c8c7b23fb5e5bb1c3e9358b2aea388c2d6e09 100755 --- a/script/install-opam-packages.sh +++ b/script/install-opam-packages.sh @@ -1,4 +1,9 @@ #!/bin/bash -opam depext fdkaac flac opus pulseaudio bjack alsa -y -opam install fdkaac flac opus pulseaudio bjack alsa -y +opam update -y +opam init -y +opam switch create 4.08.0 +opam install depext -y +opam depext taglib mad lame vorbis fdkaac flac opus cry samplerate pulseaudio bjack alsa liquidsoap -y +opam install taglib mad lame vorbis fdkaac flac opus cry samplerate pulseaudio bjack alsa liquidsoap -y +eval $(opam env)