rc/aircox
13
1
Fork 1
Code Issues 15 Pull Requests Projects Releases Wiki Activity

documentation et petits correctifs pour une installation locale #122

Closed
ctactic wants to merge 10 commits from ctactic:fix-localinstall into develop-1.0
pull from: ctactic:fix-localinstall
merge into: rc:develop-1.0
Conversation 2 Commits 10 Files Changed 6 +55 -32
6 changed files with 55 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 2dd482ba64 - Show all commits

14
README.md
View File

@ -1,10 +1,9 @@
![](/logo.png) ![](/logo.png)
Platform to manage a radio, schedules, website, and so on. We use the power of great tools like Django or Liquidsoap. A platform to manage radio schedules, website content, and more. It uses the power of great tools like Django or Liquidsoap.
This project is distributed under GPL version 3. More information in the LICENSE file, except for some files whose license is indicated inside source code. This project is distributed under GPL version 3. More information in the LICENSE file, except for some files whose license is indicated inside source code.
## Features ## Features
* **streams**: multiple random music streams when no program is played. We also can specify a time range and frequency for each; * **streams**: multiple random music streams when no program is played. We also can specify a time range and frequency for each;
* **diffusions**: generate diffusions time slot for programs that have schedule informations. Check for conflicts and rerun. * **diffusions**: generate diffusions time slot for programs that have schedule informations. Check for conflicts and rerun.
@ -15,6 +14,11 @@ This project is distributed under GPL version 3. More information in the LICENSE
* **cms**: content management system. * **cms**: content management system.
## Architecture and concepts
Aircox is divided in two main modules:
* `aircox`: basics of Aircox (programs, diffusions, sounds, etc. management); interface for managing a website with Aircox elements (playlists, timetable, players on the website);
* `aircox_streamer`: interact with application to generate audio stream (LiquidSoap);
## Development setup ## Development setup
Start installing a virtual environment : Start installing a virtual environment :
@ -40,6 +44,12 @@ DJANGO_SETTINGS_MODULE=instance.settings.dev ./manage.py runserver
``` ```
## Installation ## Installation
Running Aircox on production involves:
* Aircox modules and a running Django project;
* a supervisor for common tasks (sounds monitoring, stream control, etc.) -- `supervisord`;
* a wsgi and an HTTP server -- `gunicorn`, `nginx`;
* a database supported by Django (MySQL, SQLite, PostGresSQL);
### Scripts ### Scripts
Are included various configuration scripts that can be used to ease setup. They Are included various configuration scripts that can be used to ease setup. They
assume that the project is present in `/srv/apps/aircox`: assume that the project is present in `/srv/apps/aircox`:

25
docs/technicians.md
View File

@ -1,25 +0,0 @@
# General information
Aircox is a set of Django applications that aims to provide a radio management solution, and is
written in Python 3.5.
Running Aircox on production involves:
* Aircox modules and a running Django project;
* a supervisor for common tasks (sounds monitoring, stream control, etc.) -- `supervisord`;
* a wsgi and an HTTP server -- `gunicorn`, `nginx`;
* a database supported by Django (MySQL, SQLite, PostGresSQL);
# Architecture and concepts
Aircox is divided in three main modules:
* `programs`: basics of Aircox (programs, diffusions, sounds, etc. management);
* `controllers`: interact with application to generate audio stream (LiquidSoap);
* `cms`: create a website with Aircox elements (playlists, timetable, players on the website);
# Installation
# Configuration