Skip to content

Latest commit

 

History

History
263 lines (184 loc) · 11.4 KB

README.md

File metadata and controls

263 lines (184 loc) · 11.4 KB
Raw

Black Candy logo

Black Candy

CI Coverage Status Ruby Style Guide Docker Pulls

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

Screenshot

screenshot theme dark

screenshot theme light

Try The Demo

Please visit https://demo.blackcandy.org and use demo user (email: [email protected], password: foobar) to login. And feel free to try it.

Notice: This demo user does not have administrator privileges. So you cannot experience all the features in Black Candy. And all music in the demo is under non-commercial licences. You can check their licences.

Installation

⚠️ Notice: This installation instruction is for edge version, which means the docker image is build base on master branch. Because upcoming major version of Black Candy is going to have a lot of infrastructure changes. So the installation process will have a lot of difference. If you are looking for installation instruction for latest stable version, please visit here.

Black Candy use docker image to install easily. You can simply run Black Candy like this.

docker run blackcandy/blackcandy:edge

That's all. Now, you can use initial admin user to login (email: [email protected], password: foobar).

Mobile App

Black Candy now has an iOS app in beta. You can visit here and join TestFlight to give it a try. Because this iOS app still in beta, you need use the edge version of Black Candy.

Configuration

Port Mapping

Black Candy exports the 3000 port. If you want to be able to access it from the host. You can add -p 3000:3000 to the arguments of docker run command and then access either http://localhost:3000 or http://host-ip:3000 in a browser.

docker run -p 3000:3000 blackcandy/blackcandy:edge

Media Files Mounts

You can mount media files from host to container and use MEDIA_PATH environment variable to set the media path for black candy.

docker run -v /media_data:/media_data -e MEDIA_PATH=/media_data blackcandy/blackcandy:edge

Use PostgreSQL As Database

Black Candy use SQLite as database by default. Because SQLite can simplify the process of installation, and it's an ideal choice for self hosted small server. If you think SQLite is not enough or you are using some cloud service like heroku to host Black Candy, you can also use PostgreSQL as database.

docker run -e DATABASE_ADAPTER=postgresql -e DATABASE_URL=postgresql://yourdatabaseurl blackcandy/blackcandy:edge

How to Persist Data

There are two parts of data need to persist in Black Candy. First it's the data from database which store in /app/db/production.sqlite3, second it's the data from the asset of media files which store in /app/public/uploads.

touch production.sqlite3

docker run -v ./production.sqlite3:/app/db/production.sqlite3 -v ./uploads_data:/app/public/uploads blackcandy/blackcandy:edge

Enhance With Redis

By default, Black Candy use async adapter for background job and WebSockets, and use file storage for cache. It maybe not have problem when your music library isn't large or doesn't have many users to use it. But you can use Redis to enhance the experience for Black Candy.

When you have set the REDIS_URL environment variable, black candy will use Sidekiq for background job, Redis adapter for WebSockets and use Redis to store cache. In another way, you can also use REDIS_SIDEKIQ_URL, REDIS_CABLE_URL, and REDIS_CACHE_URL to set those service separately.

docker run -e REDIS_URL=redis://yourredisurl blackcandy/blackcandy:edge

Nginx To Send File

Black Candy supports use Nginx to delivery audio file to client. It's a more effective way than handle by Black Candy backend. And Black Candy docker image are also ready for nginx-proxy, which means you can setup a Nginx proxy for Black Candy easily. I recommend you use nginx-proxy with Black Candy.

You can use docker-compose to setup those services. The docker-compose.yml file looks like this:

version: '3'

services:
  nginx-proxy:
    image: nginxproxy/nginx-proxy
    ports:
      - "80:80"
    volumes:
      - ./blackcandy.local:/etc/nginx/vhost.d/blackcandy.local:ro
      - /var/run/docker.sock:/tmp/docker.sock:ro
      - /media_data:/media_data # Keep the path of media files in container same as blackcandy container.

  app:
    image: blackcandy/blackcandy:edge 
    volumes:
      - ./log:/app/log
      - ./production.sqlite3:/app/db/production.sqlite3
      - ./uploads_data:/app/public/uploads
      - /media_data:/media_data
    environment:
      VIRTUAL_HOST: blackcandy.local
      MEDIA_PATH: /media_data
      NGINX_SENDFILE: "true" # Don't foreget to set `NGINX_SENDFILE` environment variable to true to enable nginx sendfile.
# Get the default sendfile config for blackcandy. This file need to mount to nginx proxy container to add custom configuration for nginx.
curl https://raw.githubusercontent.com/blackcandy-org/black_candy/master/config/nginx/sendfile.conf > blackcandy.local 

docker-compose up

Embedded Sidekiq

By default, you need another process to run Sidekiq for background job. Like this:

version: '3'
services:
  app: &app_base
    image: blackcandy/blackcandy:edge
    volumes:
      - ./log:/app/log
      - ./production.sqlite3:/app/db/production.sqlite3
      - ./uploads_data:/app/public/uploads
      - /media_data:/media_data
  sidekiq:
    <<: *app_base
    command: bundle exec sidekiq

But you can also use embedded mode of Sidekiq if you don't want another separate Sidekiq process. This can help your deployment become easier. All you need to do is to set EMBEDDED_SIDEKIQ environment variable to true.

Listener For Media Library

Listener for media library can automatically sync for media library changes. You need another process to run the listener.

version: '3'
services:
  app: &app_base
    image: blackcandy/blackcandy:edge
    volumes:
      - ./log:/app/log
      - ./production.sqlite3:/app/db/production.sqlite3
      - ./uploads_data:/app/public/uploads
      - /media_data:/media_data
  listener:
    <<: *app_base
    command: bundle exec rails listen_media_changes

Environment Variables

Name Default Description
REDIS_URL The URL of Redis, when this environment variable has been set Black Candy will use Sidekiq for background job, Redis adapter for WebSockets and use Redis to store cache
REDIS_CACHE_URL REDIS_URL This environment variable can override the REDIS_URL, if you want to set different Redis URL for cache.
REDIS_SIDEKIQ_URL REDIS_URL This environment variable can override the REDIS_URL, if you want to set different Redis URL for Sidekiq.
REDIS_CABLE_URL REDIS_URL This environment variable can override the REDIS_URL, if you want to set different Redis URL for WebSockets.
DATABASE_URL The URL of PostgreSQL database. You must set this environment variable if you use PostgreSQL as database.
MEDIA_PATH You can use this environment variable to set media path for Black Candy, otherwise you can set media path in settings page.
DATABASE_ADAPTER "sqlite" There are two adapters are supported, "sqlite" and "postgresql".
NGINX_SENDFILE false Whether enable Nginx sendfile.
EMBEDDED_SIDEKIQ false Whether enable embedded mode of Sidekiq.
EMBEDDED_SIDEKIQ_CONCURRENCY 2 The concurrency number of embedded Sidekiq. This value should not greater than 2. Because we should keep embedded Sidekiq concurrency very low. For more details, see this document about embedded Sidekiq.
SECRET_KEY_BASE When the SECRET_KEY_BASE environment variable is not set, Black candy will generate SECRET_KEY_BASE environment variable every time when service start up. This will cause old sessions invalid, You can set your own SECRET_KEY_BASE environment variable on docker service to avoid it.
FORCE_SSL false Force all access to the app over SSL.

Upgrade

Pull new image from remote

$ docker pull blackcandy/blackcandy:edge

Development

Requirements

  • Ruby 3.1
  • Node.js 14
  • Yarn
  • ImageMagick
  • FFmpeg

Make sure you have installed all those dependencies.

Install gem dependencies

bundle install

Install JavaScript dependencies

yarn install

Database Configuration

rails db:prepare
rails db:seed

Start all services

After you’ve set up everything, now you can running ./bin/dev to start all service you need to develop. Then visit http://localhost:3000 use initial admin user to login (email: [email protected], password: foobar).

Test

# Runing all test
$ rails test:all 

# Runing lint
$ rails lint:all

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.

Licences Of The Music In Demo

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

Sponsorship

This project is supported by: