Go to file

Agatha Lovelace c7b3b3c745 Fix songs that incorrectly tag missing year as year 0		2022-10-06 15:13:09 +02:00
src	Fix songs that incorrectly tag missing year as year 0	2022-10-06 15:13:09 +02:00
.gitignore	V1 Server implementation	2022-09-22 23:31:46 +02:00
Cargo.lock	V1 Server implementation	2022-09-22 23:31:46 +02:00
Cargo.toml	V1 Server implementation	2022-09-22 23:31:46 +02:00
README.md	Add README	2022-09-23 19:43:46 +02:00

README.md

Eleanor Server

A HTTP remote media server for the Eleanor music player.

Usage (command line)

Setup:
1. Run the eleanor-server executable; exit
2. Edit the settings.toml file. Example:
```
port = 8008

[[sources]]
id = 0
path = "/home/agatha/Music/local/"
```
1. Add user(s) using the user subcommand
2. Start the server again

Adding a user:

./eleanor-server user add username password

Removing a user:
```
./eleanor-server user remove username 
```

REST API Implementation

GET / → A binary messagepack-encoded list of tracks indexed by the server
POST / → Starts a full reindex by the server
GET /:hash → Responds with the requested song's audio file (hash can be obtained from the index)
GET /:hash/cover → Responds with the album art attached to the requested song's file

All endpoints require HTTP Basic Auth using credentials of any formerly added user.