Skip to content
Snippets Groups Projects
Commit 12076a49 authored by David Trattnig's avatar David Trattnig
Browse files

Revert sections.

parent f169dcb3
No related branches found
No related tags found
No related merge requests found
# 1. Aura Engine
# Aura Engine
<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-engine.png" width="250" align="right" />
......@@ -8,26 +8,26 @@ specifically build for the requirements of community radios.
<!-- TOC -->
- [1. Aura Engine](#1-aura-engine)
- [1.1. Features](#11-features)
- [1.2. Architecture](#12-architecture)
- [1.3. Requirements](#13-requirements)
- [1.4. Installation](#14-installation)
- [1.4.1. Install System Libraries](#141-install-system-libraries)
- [1.4.2. Install Engine](#142-install-engine)
- [1.4.3. Setup Database](#143-setup-database)
- [1.4.4. Configuration](#144-configuration)
- [1.5. Running Engine](#15-running-engine)
- [1.5.1. Development](#151-development)
- [1.5.2. Production](#152-production)
- [1.5.2.1. API Server](#1521-api-server)
- [1.6. Logging](#16-logging)
- [1.7. About](#17-about)
- [1.8. Resources](#18-resources)
- [Aura Engine](#aura-engine)
- [Features](#features)
- [Architecture](#architecture)
- [Requirements](#requirements)
- [Installation](#installation)
- [Install System Libraries](#install-system-libraries)
- [Install Engine](#install-engine)
- [Setup Database](#setup-database)
- [Configuration](#configuration)
- [Running Engine](#running-engine)
- [Development](#development)
- [Production](#production)
- [API Server](#api-server)
- [Logging](#logging)
- [About](#about)
- [Resources](#resources)
<!-- /TOC -->
## 1.1. Features
## Features
- Play audio from multiple sources
- Dynamic switching of sources
......@@ -44,7 +44,7 @@ specifically build for the requirements of community radios.
Read more on the [Engine Features](docs/engine-features.md) page.
## 1.2. Architecture
## Architecture
AURA Engine as part of the AURA Radio Suite uses an modulear architecture
based on a REST API. All external information is retrieved using JSON data-structures.
......@@ -52,7 +52,7 @@ based on a REST API. All external information is retrieved using JSON data-struc
To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or visit
the [Aura Meta](https://gitlab.servus.at/autoradio/meta) repository.
## 1.3. Requirements
## Requirements
**Hardware Requirements:** This depends on how many audio sources and targets you are
going to use, but for the most common scenarios any current hardware should be sufficient.
......@@ -62,13 +62,13 @@ To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or
It is tested and coded on Debian Stretch and Ubuntu 18.0 with Python 3.6+.
## 1.4. Installation
## Installation
```bash
git clone https://gitlab.servus.at/autoradio/engine
```
### 1.4.1. Install System Libraries
### Install System Libraries
Aura Engine requires at least Node 13 and Python 3.7.
......@@ -87,7 +87,7 @@ sudo apt install \
liquidsoap-plugin-all
```
### 1.4.2. Install Engine
### Install Engine
Development Environment:
......@@ -101,7 +101,7 @@ Production Environment:
sudo ./install.sh prod
```
### 1.4.3. Setup Database
### Setup Database
```bash
mysql -u root -p
......@@ -111,7 +111,7 @@ CREATE USER 'aura'@'localhost' IDENTIFIED BY 'secure-password';
GRANT ALL PRIVILEGES ON aura_engine.* TO 'aura'@'localhost';
```
### 1.4.4. Configuration
### Configuration
Run
......@@ -127,10 +127,10 @@ your time to carefully review those settings!
Read more about detailed settings in the [Configuration Guide](docs/configuration-guide.md).
## 1.5. Running Engine
## Running Engine
### 1.5.1. Development
### Development
While developing there is a simple convencience script `run.sh`
to get you started. Call the engine's components in following order:
......@@ -145,7 +145,7 @@ In development mode Engine uses the [Flask](https://palletsprojects.com/p/flask/
This server should not be used in your production environment.
### 1.5.2. Production
### Production
In production the process is slightly different to ensure the
engine's components are always running i.e. restart themselves after some system
......@@ -163,7 +163,7 @@ and on system boot run following:
systemctl enable aura-lqs
```
#### 1.5.2.1. API Server
#### API Server
For production Engine API uses the WSGI HTTP Server [`Gunicorn`](https://gunicorn.org/).
......@@ -185,7 +185,7 @@ In case you want to reload whole supervisor service
sudo service supervisor restart
```
## 1.6. Logging
## Logging
All Engine logs for production can be found in `/var/log/aura/engine`
......@@ -197,7 +197,7 @@ You can access the service logs using one of:
journalctl -u aura-engine
```
## 1.7. About
## About
<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-logo.png" width="150" />
......@@ -208,7 +208,7 @@ Aura Engine is the play-out engine of the Aura Radio Software Suite. Aura stands
| [Steering](https://gitlab.servus.at/autoradio/pv) | [Dashboard](https://gitlab.servus.at/autoradio/dashboard) | [Tank](https://gitlab.servus.at/autoradio/tank) | [Engine](https://gitlab.servus.at/autoradio/engine) |
## 1.8. Resources
## Resources
* **Python**: https://docs.python.org/
* **Redis**: https://redis.io/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment