Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kenellorando authored Mar 5, 2023
1 parent 707b2a3 commit d79e3e6
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Cadence** is an all-in-one web radio suite that lets you start a self-hosted radio website.

In minutes, you can create an audio stream with music search, song request, album artwork, a browser UI, and real-time stream information working out-of-the-box. You can share your Cadence Radio with listeners that may interact with it much like a traditional call-in radio station.
In minutes, you can create an audio broadcast complete with library search, song request, album artwork, a browser UI, and real-time stream information working out-of-the-box.

All components are mostly pre-configured so there is hardly any configuration required to get started. Simply provide target directory containing music files, set a few service passwords and hostnames, and deploy!

Expand All @@ -26,30 +26,29 @@ All components are mostly pre-configured so there is hardly any configuration re
## 🏃 Get Started

### Requirements
1. You must have Docker installed. If you are on a Linux server, install the [Compose plugin](https://docs.docker.com/compose/install/linux/).
1. You must have [Docker](https://docs.docker.com/engine/install/) installed. If you are on a Linux server, additionally install the [Compose plugin](https://docs.docker.com/compose/install/linux/).

### Installation
1. Fork or clone the repository.
2. Edit `config/cadence.env`
1. Edit `config/cadence.env`
1. Change all instances of `hackme` to a new password.
2. Set `CSERVER_MUSIC_DIR` to an absolute path which contains music files (`.mp3`, `.flac`) for play. The target is not recursively searched.
3. Set `CSERVER_REQRATELIMIT` to an integer that sets the song request cooldown period in seconds. Set this value to `0` to disable rate limiting.
3. Edit `config/icecast.xml`
2. Edit `config/icecast.xml`
1. Change all instances of `hackme` to a new password.
2. Set the `<hostname>` value to a URL you expect your audience to connect to. This value is what is set in the UI's stream source. This may be a DNS name or a public or private IP address. You can leave the default value `localhost` if your radio is meant to be accessible locally only.
4. Edit `config/liquidsoap.liq`
3. Edit `config/liquidsoap.liq`
1. Change all instances of `hackme` to a new password.
2. If you changed `CSERVER_MUSIC_DIR` in step 1, change any instances of the default value `/music/` to match it here.
5. (_Optional_) Edit `config/nginx.conf`
1. For advanced users deploying Cadence to a server with DNS, Cadence ships with a reverse proxy which will forward requests based on domain-name to backend services. Simply configure the `server_name` values with your domain names. The stream server domain should match the value you set in step 3.
6. `docker compose up`
4. (_Optional_) Edit `config/nginx.conf`
1. For advanced users deploying Cadence to a server with DNS, Cadence ships with a reverse proxy that can forward requests based on domain-name to backend services. Simply configure the `server_name` values with your domain names. The stream server domain should match the value you set in step 2.
5. `docker compose up`

After configuration is initially completed, you can simply run `docker compose up` again in the future to start your station.
After configuration is initially completed, you may simply run `docker compose up` again in the future to start your station.

### Accessing Services

- Assuming you kept the default values above, Cadence will become accessible in a browser at `localhost:8080`.
- If you optionally followed step 5 to make Cadence publicly accessible, open firewall port `80` and point DNS to your server.
- If you optionally followed step 4, open firewall port `80` and point DNS to your server.

## 👩‍💻 Developing

Expand Down

0 comments on commit d79e3e6

Please sign in to comment.