+
+
+
](https://apps.apple.com/app/blackcandy/id6444304071)
+[
](https://f-droid.org/packages/org.blackcandy.android/)
+
+
+For Android app, you can also download APK from [GitHub Release](https://github.com/blackcandy-org/android/releases/latest)
+
+## Configuration
+
+### Port Mapping
+
+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.
+
+```shell
+docker run -p 3000:3000 ghcr.io/blackcandy-org/blackcandy:latest
+```
+
+### 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.
+
+```shell
+docker run -v /media_data:/media_data -e MEDIA_PATH=/media_data ghcr.io/blackcandy-org/blackcandy:latest
+```
+
+### 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.
+
+```shell
+docker run -e DB_ADAPTER=postgresql -e DB_URL=postgresql://yourdatabaseurl ghcr.io/blackcandy-org/blackcandy:latest
+```
+
+### How to Persist Data
+
+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.
+
+```shell
+mkdir storage_data
+
+docker run -v ./storage_data:/app/storage ghcr.io/blackcandy-org/blackcandy:latest
+```
+
+### Logging
+
+Black 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/.
+
+## Environment Variables
+
+| Name | Default | Description |
+| --- | --- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| DB_URL | | The URL of PostgreSQL database. You must set this environment variable if you use PostgreSQL as database. |
+| CABLE_DB_URL | | The URL of Pub/Sub database. You must set this environment variable if you use PostgreSQL as database. |
+| QUEUE_DB_URL | | The URL of background job database. You must set this environment variable if you use PostgreSQL as database. |
+| CACHE_DB_URL | | The URL of cache 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". |
+| 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. |
+
+## Edge Version
+
+The edge version of Black Candy base on master branch, which means it's not stable, you may encounter data loss or other issues. However, I don't recommend normal user using an edge version. But if you are a developer who wants to test or contribute to Black Candy, you can use the edge version.
+
+```shell
+docker pull ghcr.io/blackcandy-org/blackcandy:edge
+```
+
+## Development
+
+### Requirements
+
+- Ruby 3.3
+- Node.js 20
+- libvips
+- FFmpeg
+
+Make sure you have installed all those dependencies.
+
+### Install gem dependencies
+
+```shell
+bundle install
+```
+
+### Install JavaScript dependencies
+
+```shell
+npm install
+```
+
+### Database Configuration
+
+```shell
+rails db:prepare
+rails db:seed
+```
+
+### Start all services
+
+After you’ve set up everything, now you can run `./bin/dev` to start all services you need to develop.
+Then visit 
+
diff --git a/test/controllers/api/v1/stream_controller_test.rb b/test/controllers/api/v1/stream_controller_test.rb
index a56ef15e..cb297aba 100644
--- a/test/controllers/api/v1/stream_controller_test.rb
+++ b/test/controllers/api/v1/stream_controller_test.rb
@@ -12,15 +12,6 @@ class Api::V1::StreamControllerTest < ActionDispatch::IntegrationTest
assert_response :success
end
- test "should set header for nginx send file" do
- with_env("NGINX_SENDFILE" => "true") do
- get new_api_v1_stream_url(song_id: songs(:mp3_sample).id), headers: api_token_header(@user)
-
- assert_equal Setting.media_path, @response.get_header("X-Media-Path")
- assert_equal "/private_media/artist1_album2.mp3", @response.get_header("X-Accel-Redirect")
- end
- end
-
test "should respond file data" do
get new_api_v1_stream_url(song_id: songs(:mp3_sample).id), headers: api_token_header(@user)
assert_equal binary_data(file_fixture("artist1_album2.mp3")), response.body
diff --git a/test/controllers/api/v1/transcoded_stream_controller_test.rb b/test/controllers/api/v1/transcoded_stream_controller_test.rb
index 80218e79..1d668eb2 100644
--- a/test/controllers/api/v1/transcoded_stream_controller_test.rb
+++ b/test/controllers/api/v1/transcoded_stream_controller_test.rb
@@ -69,19 +69,6 @@ def close_tmp_cache_file
end
end
- test "should send cached transcoded stream file when found cache and send file with nginx" do
- Stream.stub(:new, @stream_mock) do
- get new_api_v1_transcoded_stream_url(song_id: songs(:flac_sample).id), headers: api_token_header(@user)
- assert_response :success
-
- with_env("NGINX_SENDFILE" => "true") do
- get new_api_v1_transcoded_stream_url(song_id: songs(:flac_sample).id), headers: api_token_header(@user)
- assert_equal "/private_cache_media#{@stream_mock.transcode_cache_file_path}", @response.get_header("X-Accel-Redirect")
- assert_equal "audio/mpeg", @response.get_header("Content-Type")
- end
- end
- end
-
test "should regenerate new cache when cache is invalid" do
Stream.stub(:new, @stream_mock) do
stream = Stream.new(songs(:flac_sample))
diff --git a/test/lib/black_candy/config_test.rb b/test/lib/black_candy/config_test.rb
index dbf819a9..ac093c5c 100644
--- a/test/lib/black_candy/config_test.rb
+++ b/test/lib/black_candy/config_test.rb
@@ -37,15 +37,6 @@ class BlackCandy::ConfigTest < ActiveSupport::TestCase
end
end
- test "should get nginx_sendfile value as a boolean" do
- assert_nil ENV["NGINX_SENDFILE"]
- assert_not BlackCandy.config.nginx_sendfile?
-
- with_env("NGINX_SENDFILE" => "true") do
- assert BlackCandy.config.nginx_sendfile?
- end
- end
-
test "should raise error when database_adapter is not supported" do
with_env("DB_ADAPTER" => "invalid_adapter") do
assert_raises(BlackCandy::Config::ValidationError) do