src | ||
.env.example | ||
.gitignore | ||
Cargo.lock | ||
Cargo.toml | ||
flake.lock | ||
flake.nix | ||
README.md | ||
rust-toolchain.toml |
musikquadrupled
A proxy server for musikcubed that implements TLS, alternative authentication solution and CORS for proper Web support. Compatible with musikcube.
Configuration
The configuration is done via MUSIKQUAD_*
environment variables. Alternatively you can also provide a .env
file in the same directory as the binary or a parent directory, which will be readed and loaded as environment variables.
See .env.example
for a commented .env
file.
API (public)
All of the musikcubed
APIs are implemented. On top of those:
share/generate/:external_id
: Returns a "scoped token" for the specified ID of a music. This allows one to accessshare/*
APIs. Thetoken
query parameter must be present and must have a valid token, if not401 Unauthorized
will be returned.share/audio/:scoped_token
: Returns the music (or a range of it ifRANGE
header is present) corresponding to the specifiedscoped_token
. Returns404 Not Found
if the requested music isn't available.share/info/:scoped_token
: Returns information (title, album, artist etc.) of the music corresponding to the specifiedscoped_token
in JSON. Returns404 Not Found
if the requested music isn't available.share/thumbnail/:scoped_token
: Returns the thumbnail for the music corresponding to the specifiedscoped_token
. Returns404 Not Found
if the requested thumbnail isn't available.
API (internal)
These are only exposed to localhost
clients.
token/generate
: Generates a new token for use with thetoken
query paramater in the public APIs.token/revoke_all
: Revokes all tokens.