maxill1/juke-restainer repository overview

⁠juke-restainer

a simple api to access your ID3 tagged music library. Useful to search specific song, author or album and submit the generated url to a music renderer (Home Assistant media_player entities, Google Cast via node-red-contrib-cast, mdp, etc)

⁠configuration: folder, web and security

edit the config.json file to change port, web root and directory to scan

{
    "rootDir" : "/music", //the music folder to scan
    "webPath" : "http://192.168.1.100/music", //the web path to translate (you must share the resource with a web server)
    "port" : 3000, //the server port you are exposing
    "token" : "" //a security token you may want to add
}

⁠running

you have to provide a music folder and a config folder:

docker run --name juke-restainer -p 3000:3000 -v /host/Music:/music -v /hostConfigFilePath:/config maxill1/juke-restainer:latest 

⁠api

⁠http://yourip:3000/search/:keyword⁠

search "keyword" in title album or artist properties

⁠http://yourip:3000/file/:fileName⁠

search "fileName" in file path

⁠http://yourip:3000/artist/:artist⁠

search "artist" in artist property

⁠http://yourip:3000/title/:song⁠ or http://yourip:3000/song/:song⁠

search "song" in song property

⁠http://yourip:3000/album/:album⁠

search "album" in album property

⁠http://yourip:3000/library⁠

returns the complete json library

⁠http://yourip:3000/library/update⁠

force the update of the library