From a12e682c01f2cb9cd55877802a5396853c464b98 Mon Sep 17 00:00:00 2001 From: Yusuf Bera Ertan Date: Tue, 9 May 2023 19:02:13 +0300 Subject: [PATCH] docs: update readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 055ce56..8fe2797 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A proxy server for musikcubed that implements TLS, alternative authentication so ### 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. +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. @@ -13,9 +13,9 @@ See `.env.example` for a commented `.env` file. 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 access `share/*` APIs. This endpoint requires authentication. -- `share/audio/:scoped_token`: Returns the music (or a range of it if `RANGE` header is present) corresponding to the specified `scoped_token`. Returns `404 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 specified `scoped_token` in JSON. Returns `404 Not Found` if the requested music isn't available. -- `share/thumbnail/:scoped_token`: Returns the thumbnail for the music corresponding to the specified `scoped_token`. Returns `404 Not Found` if the requested thumbnail isn't available. +- `share/audio/:scoped_token`: Returns the music (or a range of it if `RANGE` header is present) corresponding to the specified `scoped_token`. Returns `404 Not Found` if the requested music isn't available. Returns `401 Unauthorized` if `scoped_token` is invalid. +- `share/info/:scoped_token`: Returns information (title, album, artist etc.) of the music corresponding to the specified `scoped_token` in JSON. Returns `404 Not Found` if the requested music isn't available. Returns `401 Unauthorized` if `scoped_token` is invalid. +- `share/thumbnail/:scoped_token`: Returns the thumbnail for the music corresponding to the specified `scoped_token`. Returns `404 Not Found` if the requested thumbnail isn't available. Returns `401 Unauthorized` if `scoped_token` is invalid. If an endpoint requires authentication this means you have to provide a token via a `token` query paramater in the URL. If not provided `401 Unauthorized` will be returned. For `musikcube`, this is not necessary as the server will also handle `Authentication` header for the APIs `musikcube` uses. @@ -24,4 +24,4 @@ If an endpoint requires authentication this means you have to provide a token vi These are only exposed to `localhost` clients. - `token/generate`: Generates a new token for use with the `token` query paramater in the public APIs. -- `token/revoke_all`: Revokes all tokens. \ No newline at end of file +- `token/revoke_all`: Revokes all tokens.