README.md 3.62 KB
Newer Older
1

David Trattnig's avatar
David Trattnig committed
2

David Trattnig's avatar
David Trattnig committed
3
# Aura Engine
David Trattnig's avatar
David Trattnig committed
4

David Trattnig's avatar
David Trattnig committed
5
<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-engine.png" width="250" align="right" />
David Trattnig's avatar
David Trattnig committed
6

David Trattnig's avatar
David Trattnig committed
7
Aura Engine is a play-out engine as part of [Aura Radio Software Suite](#About),
David Trattnig's avatar
David Trattnig committed
8
9
specifically build for the requirements of community radios.

David Trattnig's avatar
David Trattnig committed
10
11
<!-- TOC -->

David Trattnig's avatar
David Trattnig committed
12
13
14
15
- [Aura Engine](#aura-engine)
    - [Features](#features)
    - [Architecture](#architecture)
    - [Installation](#installation)
16
    - [Read more](#read-more)
David Trattnig's avatar
David Trattnig committed
17
18
    - [About](#about)
    - [Resources](#resources)
David Trattnig's avatar
David Trattnig committed
19
20

<!-- /TOC -->
David Trattnig's avatar
David Trattnig committed
21

David Trattnig's avatar
David Trattnig committed
22
## Features
23

David Trattnig's avatar
David Trattnig committed
24
25
26
27
28
29
30
- Play audio from multiple sources
- Dynamic switching of sources
- Record output to filesystem
- Stream output to an Icecast Server
- Multichannel Line-out
- Blank Detenction / Silence Detecter
- Auto Pilot a.k.a. Fallback Handling
31
- API to query Track-Service
32
33
34
35
- API to query monthly reports
- API to query data for a studio clock
- Web Application for displaying the Track-Service
- Web Application for displaying the studio clock
36

David Trattnig's avatar
David Trattnig committed
37
Read more on the [Engine Features](docs/engine-features.md) page.
38

David Trattnig's avatar
David Trattnig committed
39
## Architecture
40
41
42
43

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.

David Trattnig's avatar
David Trattnig committed
44
45
To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or visit
 the [Aura Meta](https://gitlab.servus.at/autoradio/meta) repository.
46

47
## Installation
48

49
50
- [Installation for Development](docs/installation-development.md)
- [Installation for Production](docs/installation-production.md)
51
- [Running with Docker](docs/running-docker.md)
52
53
- [Setup the Audio Store](docs/setup-audio-store.md)
- [Configuration Guide](docs/configuration-guide.md)
54
55
56
57
58

## Read more

- [Developer Guide](docs/developer-guide.md)
- [Engine Features](docs/engine-features.md)
David Trattnig's avatar
David Trattnig committed
59
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
David Trattnig's avatar
David Trattnig committed
60

61

David Trattnig's avatar
David Trattnig committed
62
## About
David Trattnig's avatar
David Trattnig committed
63
64
65

<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-logo.png" width="150" />

David Trattnig's avatar
David Trattnig committed
66
Aura Engine is the play-out engine of the Aura Radio Software Suite. Aura stands for Automated Radio and is a swiss army knife for community radio stations. Beside the Engine it provides Steering (Admin Interface for the radio station), Dashboard (Collaborative scheduling and programme coordination), Tank (Audio uploading, pre-processing and delivery). Read more in the [Aura Meta](https://gitlab.servus.at/autoradio/meta) repository or on the specific project pages.
David Trattnig's avatar
David Trattnig committed
67
68
69
70

| [<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-steering.png" width="150" align="left" />](https://gitlab.servus.at/autoradio/pv)  |  [<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-dashboard.png" width="150" align="left" />](https://gitlab.servus.at/autoradio/dashboard)  |  [<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-tank.png" width="150" align="left" />](https://gitlab.servus.at/autoradio/tank) | [<img src="https://gitlab.servus.at/autoradio/meta/-/raw/master/images/aura-engine.png" width="150" align="left" />](https://gitlab.servus.at/autoradio/engine)  |
|---|---|---|---|
| [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)  |
71
72


David Trattnig's avatar
David Trattnig committed
73
## Resources
74
75
76

* **Python**: https://docs.python.org/
* **Redis**: https://redis.io/
David Trattnig's avatar
David Trattnig committed
77
* **OPAM (OCaml Package Manager)**: https://opam.ocaml.org/
78
79
* **Liquidsoap**: https://www.liquidsoap.info/doc-1.4.0/
* **Jack Audio**: https://jackaudio.org/
80
81
82
* **Flask**: https://palletsprojects.com/p/flask/
* **Supervisor**: http://supervisord.org/
* **Gunicorn**: https://gunicorn.org/