Commit 25c15107 authored by David Trattnig's avatar David Trattnig
Browse files

Docs: flesh out overview

parent 27aa352e
......@@ -6,8 +6,8 @@
Automated Radio, AutoRadio, AuRa or AURA, follows an "*Automobile-naming-scheme*". All the components are named after some crucial parts of a car:
- **Steering**: This is the single source of thruth, holding all the radio data, hence steering some radio's channels.
- **Tank**: Just spleen without steam. That's where your shows, tunes and recordings are managed. Fuelling your broadcast with materials.
- **Dashboard**: Observe and control what's happening. The user interface of your radio with individual views for hosts and programme coordinators.
- **Tank**: Just spleen without steam. That's where your shows, tunes and recordings are management. Fuelling your broadcast with materials.
- **Dashboard**: Observe and control what's happening. That's the backend user interface of your radio with individual views for hosts and programme coordinators.
- **Engine**: The playout server allowing you to broadcast via FM and web audio streams. Includes silence detection and optional recording options.
- **Player**: Every car has some fancy *Auto Radio Player*. And every radio station has the need for some modern frontend experience. Player is a library of web components. Making web development a breeze. Just like *playing with blocks*.
......@@ -17,21 +17,41 @@ Automated Radio, AutoRadio, AuRa or AURA, follows an "*Automobile-naming-scheme*
<img src="https://gitlab.servus.at/aura/meta/-/raw/main/assets/images/aura-engine.png" width="128" style="float:left" alt="AURA Engine" />
<img src="https://gitlab.servus.at/aura/meta/-/raw/main/assets/images/aura-player.png" width="128" style="float:left" alt="AURA Player" />
## Simplied Overview
[<img src="https://gitlab.servus.at/aura/meta/-/raw/main/assets/images/aura-simplified-overview.png"](https://gitlab.servus.at/aura/meta/-/raw/main/assets/images/aura-simplified-overview.png)
## Services
As a has car fixed and moving parts, AURA likewise has parts which are fundamental and parts which are optional.
Same as a car has fixed and moving parts, AURA likewise has parts which are fundamental and parts which are optional.
The aforementioned naming scheme, is used as a basis for name-spacing individual services.
In order to keep administrators life simple, we have defined two component spaces:
The aforementioned naming scheme, is used as a basis for name-spacing services:
- AURA Web
- AURA Playout
These spaces are represented in form of Docker Compose bundles.
### AURA Web
| Service | Required | Description |
|--- |--- |--- |
| steering | ✅ | Single-source of truth, holding all radio, show, host<br/>and scheduling data |
| tank | ✅ | Upload, download and media-managent |
| tank | ✅ | Upload, download and media-management |
| dashboard | ✅ | Backend User Interface |
| dashboard-clock | | Studio Clock |
| player | | Library for building frontends based on web components |
The *required* services are needed for minimal functionality.
### AURA Playout
| Service | Required | Description |
|--- |--- |--- |
| engine | ✅ | Control and scheduling for the play-out |
| engine-core | ✅ | Play-out Engine |
| engine-api | | API for playlogs and track service |
| player | | Library for building frontend based on web components |
The *required* services are needed for minimal functionality.
The *required* services are needed for minimal functionality.
\ No newline at end of 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