Black candy

Black candy is a self hosted music streaming server built with Rails and Stimulus. The goal of the project is to create a real personal music center.

Screenshot

Getting started

Black candy use docker for simplify deployment, development and test process. So you should install docker and docker-compose first.

Black candy support mp3, m4a, ogg, opus, flac and wav formats now.

Installation

Black candy has built docker images. You can use docker compose to run all services.

First, you should create docker-compose.yml file for black candy.

Here is the example docker-compose.yml you can use. You can also change the docker-compose.yml for your own needs.

Second, set BLACK_CANDY_MEDIA_PATH and BLACK_CANDY_SECRET_KEY_BASE environment variable on your sever and point BLACK_CANDY_MEDIA_PATH to the readable directory on your server to store your music files.

# Like this
$ export BLACK_CANDY_MEDIA_PATH="/example_media_path"
$ export BLACK_CANDY_SECRET_KEY_BASE="your_secret_key"

Finally run:

$ docker-compose up -d

That's all.

You can use initial admin user to login (email: admin@admin.com, password: foobar).

Try in PWD

You can try black candy on Play with Docker

When the service is ready, access black candy from port 80. Then use initial admin user to login (email: admin@admin.com, password: foobar). This demo already contains some sample music file. You can go to the setting page and click the sync button of the media path to import the sample music into the database.

And feel free to try it.

List for all sample music for the demo:

Kurt Vile - Live at WFMU on Talk's Cheap 8/11/2008 (licensed under Attribution-NonCommercial-ShareAlike 3.0)
Wooden Shjips - Live at ATP NY 2008 (licensed under Attribution-Noncommercial-No Derivative Works 3.0 United States)
Ty Segall - Live at WFMU on The Cherry Blossom Clinic with Terre T June 25, 2011 (licensed under Attribution-Noncommercial-No Derivative Works 3.0 United States)
Thee Oh Sees - Peanut Butter Oven EP (licensed under Attribution-Noncommercial-Share Alike 3.0 United States)

If like their music, you can buy their albums to support them.

Upgrade

Pull new image from remote

$ docker pull blackcandy/blackcandy

Restart services:

$ docker-compose restart

Development

# Clone the repo
$ git clone https://github.com/aidewoode/black_candy.git

# Setup development environment
$ make dev_setup

# Runing development server
$ make dev_run

# Stop development server
$ make dev_stop

# Into development shell
$ make dev_shell

Test

# Runing test
$ make test_run

# Runing lint
$ make lint_run

Integrations

Black candy support get artist and album image from Discogs API. You can create a API token from Discogs and set Discogs token on Setting page to enable it.

abhionlyone/black_candy