Commit b2cf613b authored by David Trattnig's avatar David Trattnig
Browse files

Updated documentation for installation process.

parent 607b31b7
......@@ -14,10 +14,7 @@ specifically build for the requirements of community radios.
- [Architecture](#architecture)
- [Requirements](#requirements)
- [Installation](#installation)
- [Install System Libraries](#install-system-libraries)
- [Install Engine](#install-engine)
- [Setup Database](#setup-database)
- [Configuration](#configuration)
- [Configuration](#configuration)
- [Running Engine](#running-engine)
- [Development](#development)
- [Production](#production)
......@@ -65,35 +62,16 @@ It is tested and coded on Debian Stretch and Ubuntu 18.0.
## Installation
```bash
git clone https://gitlab.servus.at/autoradio/engine
```
### Install System Libraries
Aura Engine requires at least `Node 13`, `Python 3.7`. Then install `Liquidsoap 1.4.1` using [OPAM](https://www.liquidsoap.info/doc-1.4.1/install.html).
Having these installed you need to
```bash
sudo apt install \
git \
supervisor \
redis-server \
libsndfile1 ffmpeg \
mariadb-server libmariadbclient-dev \
quelcom \
```
And finally
```bash
opam depext fdkaac flac opus pulseaudio bjack alsa
opam install fdkaac flac opus pulseaudio bjack alsa
git clone https://gitlab.servus.at/autoradio/engine
```
### Install Engine
By default Aura Engine uses MariaDB for persistence. When starting the installation, please
ensure you have root access to your database instance. The installation script automatically
creates a database plus an associated user with password. If you want to use your own database
system, select "Other / Manually" during the database installation step.
Development Environment
......@@ -107,17 +85,8 @@ Production Environment
sudo ./install.sh prod
```
### Setup Database
```bash
mysql -u root -p
CREATE DATABASE aura_engine CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'aura'@'localhost' IDENTIFIED BY 'secure-password';
GRANT ALL PRIVILEGES ON aura_engine.* TO 'aura'@'localhost';
```
### Configuration
## Configuration
In your development envirnment edit the file
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment