README.md 6.98 KB
Newer Older
david's avatar
david committed
1

david's avatar
david committed
2

David Trattnig's avatar
David Trattnig committed
3
<img src="./assets/images/aura-logo.png" width="200" vspace="20" />
david's avatar
david committed
4

david's avatar
david committed
5
```bash
6
7
8
9
10
11
12
13
14
[meta]: Hello, welcome, this is meta!
[you]: Oh, hi meta, what are you meta about?
[meta]: I am the place where all the work behind the 'real' work is happening.
[meta]: I collect stuff about the AuRa project and greet new visitors.
[you]: Ah, kool. Well... I am a new visitor, what can you tell me about this?
[meta]: **loading project overview info**
[meta]: Hello new visitor, here you go:
```

david's avatar
david committed
15
# AuRa - automated radio playout and management for community radio stations
16
17
18
19
20
21
22
23
24
25
26
27
28

What is this about? You probably already know. If not, here are some links
that explain in more detail what the community radio stations in .AT land and
.DE land are which call themselves _Freie Radios_ (literally it would be
translated to _free radios_, but as the thing with _free_ here is the same
as with [free software](https://en.wikipedia.org/wiki/Free_and_open-source_software#Free_software)
in general).

Unfortunately most of those links are in German language as our constituency
is located primarily in Austria and German. We will provide a short intro
in English language as soon as we find some time.

About _Freie Radios_:
29

David Trattnig's avatar
David Trattnig committed
30
31
32
33
34
* http://freie-radios.at - Austrian association of community radio stations
* http://freie-radios.de - German association of community radio stations
* https://cba.fro.at - Audio portal of Austrian community radio stations
* https://freie-radios.net - Audio portal of German community radio stations
* https://amarceurope.eu/ - European association of community radio stations
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

**And what is this here now?**

_AuRa_ is an attempt to create a suite of program scheduling and playout
automation software that fits the needs of free radio stations. The initiative
took of in Austria, where several stations are still using and depending on
_Y.A.R.M._ (which is just yet another radio manager). _Y.A.R.M._ was an
awesome project that provided a software which was tailored to how
community radio stations create their diverse programmes. Unfortunately it
is also a piece of monolithic Java code that has come into the years.
Also it never really took of as a free software project and depended on
single developers. Today nobody really wants to touch its code anymore.

Now we urgently need something new, and all those other solutions out there
(FLOSS as well as commercial) do not really fulfill all our requirements.
Therefore we decided to pool our resources and develop something new, while
reusing a lot of work that has already been done at one or another stations.

53
## Architecural principles
54
55

Some of our core organisational and architectural requirements for _AuRa_ are:
56

57
58
59
60
* **Modular architecture**: the whole suite should be made up of modular components which could be exchanged with other custom components
* **Transparent API**: every component shall provide a well-documented API through which other components can interact with it, ideally as a REST API
* **Reuse of existing components**: we do not want to reinvent the wheel. Several stations already developed single components as free software and we can adapt and build on those
* **Modern frameworks**: we do not code from scratch but use modern application development frameworks which provide maintainability as well as security
61

62
If you are interested in more technical details, check out the [Developer Guide](docs/development/index.md)
david's avatar
david committed
63

David Trattnig's avatar
David Trattnig committed
64
## Component spaces
65

David Trattnig's avatar
David Trattnig committed
66
So we have two *component spaces* for our architecture. Each space defines the nature of the components it holds
67

David Trattnig's avatar
David Trattnig committed
68
* **AURA Web** - Holds all the web applications, data store and media management
69

David Trattnig's avatar
David Trattnig committed
70
71
72
73
74
  * [Steering](https://gitlab.servus.at/aura/steering) - this is the scheduling module, where the actual program schedule of the whole station is stored as well as all infos regarding single shows and emissions. This module mainly acts as the administration interface, while most users will use *Dashboard* to get their work done.
  
  * [Tank](https://gitlab.servus.at/aura/tank) - just spleen without steam. Our tank is an importer module that is used to upload preprocessed emissions (audio data) and to streamline all audio so our _engine_ gets only the good stuff to power our radio channels. The module talks to *Steering* via OpenID to retrieves the current schedules. Additionally it delivers audio to the *Engine*.
  
  * [Dashboard](https://gitlab.servus.at/aura/dashboard) - this is the frontend, were we get a good look on our shows and files to play. The interface aims for a simple experience and allows hundrets of people collaborating within the radio station. The module talks to *Steering* and *Tank* via OpenID, to retrieve program information as well as uploading audio files. Note the *Dashboard* itself has no data-store.
david's avatar
david committed
75

David Trattnig's avatar
David Trattnig committed
76
  * [Dashboard Clock](https://gitlab.servus.at/aura/dashboard-clock) - A modern studio clock.
77

David Trattnig's avatar
David Trattnig committed
78
79
80
81
82
* **AURA Play-out** - Everything what's needed to turn data into sound
  
  * [Engine Core](https://gitlab.servus.at/aura/engine) - this is where the schedule is actually translated into some stream of sound, our play-out server. It is responsible for playing the right audio at the planned times.
  
  * [Engine Control](https://gitlab.servus.at/aura/engine) - the place where the actual scheduling happens. A remote control for Engine Core.
david's avatar
david committed
83

David Trattnig's avatar
David Trattnig committed
84
  * [Engine API](https://gitlab.servus.at/aura/engine) - this is where the schedule is actually translated into some stream of sound, our play-out server. It is responsible for playing the right audio at the planned times.
david's avatar
david committed
85

David Trattnig's avatar
David Trattnig committed
86
## Getting started
87

David Trattnig's avatar
David Trattnig committed
88
* [User Guide](docs/user/index.md)
David Trattnig's avatar
David Trattnig committed
89
* [Administration Guide](docs/administration/index.md) 
David Trattnig's avatar
David Trattnig committed
90
  * [Installation Guide](docs/administration/index.md#installation)
David Trattnig's avatar
David Trattnig committed
91
  * [Maintenance Guide](docs/administration/maintenance-guide.md)
David Trattnig's avatar
David Trattnig committed
92
* [Developer Guide](docs/development/index.md)
David Trattnig's avatar
David Trattnig committed
93
* [Release Management](docs/development/dev-releases.md)
David Trattnig's avatar
David Trattnig committed
94

David Trattnig's avatar
David Trattnig committed
95
## Contributions and contact
david's avatar
david committed
96

David Trattnig's avatar
David Trattnig committed
97
98
In case you face a bug - [let us know!](docs/development/bug-reports.md)

David Trattnig's avatar
David Trattnig committed
99
To support the project in any way, check out the [contributions page](docs/development/contributions.md).
100

David Trattnig's avatar
David Trattnig committed
101
You can reach out to us via email at `aura-dev (at) subsquare.at` or get in touch via the [Aura Mailinglist (aura-users)](https://mailman.o94.at/mailman/listinfo/aura-users).
david's avatar
david committed
102

103
104
105
106
# Sponsors

Current sponsors include:

David Trattnig's avatar
David Trattnig committed
107
<a href="https://o94.at/"><img src="https://o94.at/themes/custom/radio_orange/logo2.png" width="500" style="margin:64px" /></a>
David Trattnig's avatar
David Trattnig committed
108
<br/><br/>
David Trattnig's avatar
David Trattnig committed
109
<a href="https://helsinki.at/"><img src="https://helsinki.at/wp-content/uploads/logo.png" width="300" style="margin:64px" /></a>
David Trattnig's avatar
David Trattnig committed
110
<br/><br/>
David Trattnig's avatar
David Trattnig committed
111
<a href="https://www.fro.at/"><img src="./assets/images/logo-radio-fro.jpg" width="150" style="margin:64px" /></a>
David Trattnig's avatar
David Trattnig committed
112
<br/><br/>
David Trattnig's avatar
David Trattnig committed
113
<a href="https://www.frf.at/"><img src="https://www.frf.at/wp-content/uploads/cropped-FRFlogofont_mHand_einzeil1.jpg" width="400" style="margin:64px" /></a>
114
115
116


# License
david's avatar
david committed
117
118
119
120

All Aura source code is licensed under [GNU Affero General Public License (AGPL) v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html).

All graphic materials and text are licensed under [Creative Commons BY-NC-SA v3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/)