tilderadio
/
AzuraCast
mirror of https://github.com/AzuraCast/AzuraCast.git
4
0
Fork 0
Code Issues Releases Wiki Activity
AzuraCast/Readme.md

123 lines
6.8 KiB
Markdown
Raw Normal View History

Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
![](https://github.com/SlvrEagle23/AzuraCast/raw/master/resources/azuracast.png)
Update the readme to reflect its current feature set.
2016-09-24 22:10:31 +00:00
# AzuraCast: A Self-Hosted Web Radio Manager
Heavy cleanup, adoption of the \App\ namespace (replacing both \DF\ and \PVL), removing unused ORM entities, services, and files. Updating readme to indicate heavy development status.
2016-05-02 03:17:53 +00:00
Fix redundancy issues in JS, add badge to readme and remove CSS inspection.
2016-10-13 17:18:59 +00:00
[![Code Climate](https://codeclimate.com/github/SlvrEagle23/AzuraCast/badges/gpa.svg)](https://codeclimate.com/github/SlvrEagle23/AzuraCast)
Associate Travis CI test coverage report with CodeClimate.
2016-10-22 17:05:52 +00:00
[![Test Coverage](https://codeclimate.com/github/SlvrEagle23/AzuraCast/badges/coverage.svg)](https://codeclimate.com/github/SlvrEagle23/AzuraCast/coverage)
Fixes to Ansible deploy for Travis CI.
2016-10-21 05:29:46 +00:00
[![Build Status](https://travis-ci.org/SlvrEagle23/AzuraCast.svg?branch=master)](https://travis-ci.org/SlvrEagle23/AzuraCast)
Fix redundancy issues in JS, add badge to readme and remove CSS inspection.
2016-10-13 17:18:59 +00:00
Update the readme to reflect its current feature set.
2016-09-24 22:10:31 +00:00
**AzuraCast** is a standalone, turnkey web radio management kit. Using its easy installer, you can go from a fresh Linux installation to a fully working web radio station in about 5 minutes.
Heavy cleanup, adoption of the \App\ namespace (replacing both \DF\ and \PVL), removing unused ORM entities, services, and files. Updating readme to indicate heavy development status.
2016-05-02 03:17:53 +00:00
Update the readme to reflect its current feature set.
2016-09-24 22:10:31 +00:00
Although AzuraCast's code history is extensive, the AzuraCast project itself is fairly new. That's because AzuraCast was built on top of [PVLive](https://github.com/SlvrEagle23/Ponyville-Live), a project originally built for a single fan community, then expanded to serve radio stations of all types as a standalone piece of software.
Bump version and language up to "Alpha", as a number of existing installations exist now and have proven to be stable.
2016-09-06 15:08:02 +00:00
Update the readme to reflect its current feature set.
2016-09-24 22:10:31 +00:00
**AzuraCast is currently in alpha.** The web application is stable and includes a number of powerful features, but if you want to keep up to date with the latest version of the software, keep in mind that updates may cause unexpected issues or data loss. Always make sure to keep your files backed up, especially the files contained in `/var/azuracast/stations`.
Creation of a readme, to satisfy my friend berwyn. :P
2014-06-05 05:54:11 +00:00
Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
To use AzuraCast, you should have a basic understanding of the Linux shell terminal. Once installed, every aspect of your radio station can be managed via AzuraCast's web interface with no advanced Linux knowledge required.
## Features
Readme list format.
2014-06-05 05:55:52 +00:00
Update the readme to reflect its current feature set.
2016-09-24 22:10:31 +00:00
With AzuraCast, you can:
* **Manage your Media:** Upload songs from the web, organize music into folders, and preview songs in your browser.
* **Create Playlists:** Set up standard playlists that play all the time, scheduled playlists for time periods, or special playlists that play once per x songs, or once per x minutes.
* **Set Up Live DJs:** Enable or disable live broadcasting from streamers/DJs, and create individual accounts for each streamer to use.
Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
* **Take Listener Requests:** Let your listeners request specific songs from your playlists, both via an API and a simple public-facing listener page.
Update the readme to reflect its current feature set.
2016-09-24 22:10:31 +00:00
* **Analytics and Reports:** Keep track of every aspect of your station's listeners over time. View reports of each song's performance and
* **Station Autopilot:** AzuraCast can automatically assign songs to a playlist based on the song's impact on listener numbers.
* **Delegate Management:** Create and remove separate administrator accounts for each station manager.
* ...and more.
Creation of a readme, to satisfy my friend berwyn. :P
2014-06-05 05:54:11 +00:00
Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
### Supported AutoDJ Software
AzuraCast uses [LiquidSoap](http://liquidsoap.fm/) as an "AutoDJ" to shuffle songs and playlists and provide an always-online radio stream.
### Supported Radio Frontends
AzuraCast currently has modules to support these radio broadcasting services:
* [IceCast](http://icecast.org/) v2.4
* [ShoutCast](http://wiki.shoutcast.com/wiki/SHOUTcast_Broadcaster) v2.x
You can also use AzuraCast as a tool for syndicating remote stations. This allows you to take advantage of the powerful analytics and reporting tools in AzuraCast for any radio station that uses IceCast or ShoutCast 1 or 2.
### Supported Operating Systems
AzuraCast supports these operating systems and architectures out of the box:
* Ubuntu 14.04 LTS (Trusty) x64
* Ubuntu 16.04 LTS (Xenial) x64
* Ubuntu 16.04 LTS (Xenial) ARM
Minor update to formatting on readme.
2016-10-06 07:48:16 +00:00
## Installing AzuraCast
### Installing on a Production Server
Update readme to include early production deploy instructions.
2016-05-17 08:40:21 +00:00
Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
AzuraCast is highly optimized for speed and performance, and can run on very inexpensive hardware, from the Raspberry Pi 3 to the lowest-level VPSes offered by most providers.
Since AzuraCast installs its own radio tools, databases and web servers, you should always install AzuraCast on a "clean" server instance with no other web or radio software installed previously.
Emphasize the root user aspect of the initial install.
2017-02-20 09:18:44 +00:00
Execute these commands **as the root user** to set up your AzuraCast server:
Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
```bash
apt-get update
apt-get install -q -y git
mkdir -p /var/azuracast/www
cd /var/azuracast/www
git clone https://github.com/SlvrEagle23/AzuraCast.git .
chmod a+x install.sh
./install.sh
```
Emphasize the root user aspect of the initial install.
2017-02-20 09:18:44 +00:00
If you cannot directly log in as the root account on your server, try running `sudo su` before running the commands above.
Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
The installation process will take between 5 and 15 minutes, depending on your Internet connection. If you encounter an error, let us know in the [Issues section](https://github.com/SlvrEagle23/AzuraCast/issues).
Once the terminal-based installation is complete, you can visit your server's public IP address (`http://ip.of.your.server/`) to finish the web-based setup.
#### Updating
AzuraCast also includes a handy updater script that pulls down the latest copy of the codebase from Git, flushes the site caches and makes any necessary database updates. Run these commands as any user with `sudo` permissions:
```bash
cd /var/azuracast/www
chmod a+x update.sh
./update.sh
```
Don't stop cron tasks during update (it also stops the broadcast services), add update script info to readme.
2016-05-17 09:00:16 +00:00
Minor update to formatting on readme.
2016-10-06 07:48:16 +00:00
### Local Development with Vagrant
Creation of a readme, to satisfy my friend berwyn. :P
2014-06-05 05:54:11 +00:00
Restructure the readme document, update text to indicate new features and move production install instructions back to the main readme. [ci skip]
2016-11-30 20:52:58 +00:00
To make local development and testing easier, AzuraCast also includes the necessary configuration to set up a Vagrant box on your computer.
See [the AzuraCast Wiki](https://github.com/SlvrEagle23/AzuraCast/wiki/Developing-Locally) for detailed instructions on the installation process.
More readme changes.
2015-03-06 00:48:26 +00:00
Minor update to formatting on readme.
2016-10-06 07:48:16 +00:00
## Screenshots
Take a look at samples of the AzuraCast interface on the [Screenshots](https://github.com/SlvrEagle23/AzuraCast/wiki/Screenshots) page on the Wiki.
Add a link to the APIary in the main readme.
2016-09-06 20:53:37 +00:00
## AzuraCast API
Once installed and running, AzuraCast exposes an API that allows you to monitor and interact with your stations.
Update API url. [ci skip]
2017-01-21 03:46:39 +00:00
Documentation about this API and its endpoints are available on the [AzuraCast API Documentation](http://azuracast.com/api/).
Add a link to the APIary in the main readme.
2016-09-06 20:53:37 +00:00
More clarification to the main readme file.
2016-09-06 15:13:34 +00:00
## License
AzuraCast is licensed under the [Apache license, version 2.0](https://github.com/SlvrEagle23/AzuraCast/blob/master/License.txt).
Some cleanup of root-level repo information (readme, image, compass sass file).
2015-03-06 00:39:11 +00:00
## Questions? Comments? Feedback?
Initial commit of AzuraCast codebase.
2016-05-01 00:15:05 +00:00
AzuraCast is a volunteer project, and we depend on your support and feedback to keep growing.
Some cleanup of root-level repo information (readme, image, compass sass file).
2015-03-06 00:39:11 +00:00
Fine-tuning the Vagrant deploy script, continuing refactor of DF/PVL to \App, remove ThirdParty libraries.
2016-05-02 08:18:32 +00:00
Issues for this codebase are tracked in this repository's Issues section on GitHub. Anyone can create a new issue for the project, and you are encouraged to do so.
Initial commit of AzuraCast codebase.
2016-05-01 00:15:05 +00:00
Add "Support AzuraCast Development"
2016-09-20 00:02:27 +00:00
## Support AzuraCast Development
AzuraCast will always be available free of charge, but if you find the software useful and would like to support the project's lead developer, click the link below to buy me a coffee. Your support is greatly appreciated.
<a href='https://ko-fi.com/A736ATQ' target='_blank'><img height='32' style='border:0px;height:32px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=b' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
Initial commit of AzuraCast codebase.
2016-05-01 00:15:05 +00:00
## Contribute to AzuraCast
Add "Support AzuraCast Development"
2016-09-20 00:02:27 +00:00
This codebase is Free and Open Source Software, both to help our team maintain transparency and to encourage contributions from the developer community. If you see a bug or other issue with the codebase, please report an issue or submit a pull request!