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.
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.
⚠️ 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 -p 3000:3000 ghcr.io/blackcandy-org/blackcandy:edge That's all. Now, you can access either http://localhost:3000 or http://host-ip:3000 in a browser, and use initial admin user to login (email: [email protected], password: foobar).
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.
Black Candy exports the 3000 port. If you want to be able to access it from the host, you can use the -p option to map the port.
docker run -p 3000:3000 ghcr.io/blackcandy-org/blackcandy:edgeYou 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 ghcr.io/blackcandy-org/blackcandy:edge 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 DB_ADAPTER=postgresql -e DB_URL=postgresql://yourdatabaseurl ghcr.io/blackcandy-org/blackcandy:edge All the data that need to persist in Black Candy are stored in /app/storage, So you can mount this directory to host to persist data.
mkdir storage_data
docker run -v ./storage_data:/app/storage ghcr.io/blackcandy-org/blackcandy:edge 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: ghcr.io/blackcandy-org/blackcandy:edge
volumes:
- ./storage_data:/app/storage
- /media_data:/media_data
environment:
VIRTUAL_HOST: blackcandy.local
MEDIA_PATH: /media_data
NGINX_SENDFILE: "true" # Don't forget 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 upBlack Candy logs to STDOUT by default. So if you want to control the log, Docker already supports a lot of options to handle the log in the container. see: https://docs.docker.com/config/containers/logging/configure/.
| Name | Default | Description |
|---|---|---|
| DB_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. | |
| DB_ADAPTER | "sqlite" | There are two adapters are supported, "sqlite" and "postgresql". |
| NGINX_SENDFILE | false | Whether enable Nginx sendfile. |
| 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. |
| DEMO_MODE | false | Whether to enable demo mode, when demo mode is on, all users cannot access administrator privileges, even user is admin. And also users cannot change their profile. |
Pull new image from remote
$ docker pull ghcr.io/blackcandy-org/blackcandy:edge - Ruby 3.2
- Node.js 20
- libvips
- FFmpeg
Make sure you have installed all those dependencies.
bundle installnpm installrails db:prepare
rails db:seedAfter 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).
# Running all test
$ rails test:all
# Running lint
$ rails lint:allBlack 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.
-
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 you like their music, you can buy their albums to support them.
This project is supported by:
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent