CSV over HTTP server configuration

The forum for designers and developers.
User avatar
Service-Team
Posts: 2446
Joined: 7. Dec 04, 04:48
Location: Germany

CSV over HTTP server configuration

Postby Service-Team » 18. Dec 05, 02:35

EDIT: This documentation is no longer updated, please refer to https://github.com/r10s/silverjuke/blob ... er-http.md for more recent information.

Silverjuke 2.00 introduces the possibility to read music libraries from HTTP-servers [1]. For this purpose, Silverjuke searches a configuration file named music-lib-cfg.txt in the server's root or in the used root directory [2].

If you use HTTP servers provided by well-known instances, the configuration is done automatically. In these cases, there is no need to read on. Also note, that all this is still in a beta state and is subject to change in future versions of Silverjuke.

However, if you want to set up your own HTTP server with your music library and want Silverjuke to read this archive, here's the description of the file format:

The "music-lib-cfg.txt" File Format


  • Each line of the text file has the format setting=value, the value may not exceed one line. Spaces or tabs at the beginning or at the end of the setting name are ignored. Same for the value.
  • Lines starting with a semicolon are ignored and may be used for comments. Semicolons inside a line do not introduce a comment.

Possible settings


  • access-type=<type> - the type of the index, currently only CSV index are read and the only valid type is

    csv-over-http

    If this setting is not provided, the server cannot be used.
  • csv-file=<path> - enter the path to the CSV index file here. Eg. if your index file is located at "http://www.myserver.com/music/index.csv" please enter

    music/index.csv
  • csv-delim=<character> - The character used to separate fields from each other, defaults to the comma.
  • csv-enclose=<character> - The character used to (optionally) enclose the field data, defaults to the upper double quote.
  • csv-escape=<character> - The characted used to escape the enclosing character inside a field, also defaults to the upper double quote.
  • csv-skip-first-row=0|1 - If the first line of the CSV index just defines the field names and should be ignored therefore, use csv-skip-first-row=1 - otherwise, use csv-skip-first-row=0 or leave this setting out.
  • csv-columns=<columnDefinitions> - A comma separated list of the columns used in the CSV index. Eg. if your CSV index contains four columns with an ID and the artist/album/track names, you have to enter

    <TrackId>,<Artist>,<Album>,<Title>

    here. In common, you may use any names and re-use them eg. for the music-files setting as described below - however, some names are recognized as known fields and will be added to the database:

    <Nr>
    <DiskNr>
    <Title>
    <Artist>
    <OrgArtist>
    <Composer>
    <Album>
    <Album(DiskNr)> (the album name optionally followed by a disk number)
    <Year>
    <Comment>
    <Genre>
    <Group>
    <Seconds>
    <Milliseconds>
  • img-files=<pathWithPlaceholders> - The path to an image that may be used as a cover, the path may contain placeholders that refer to the current record, eg. if you have one image for each track, you may use

    music/images/cover-<TrackId>.jpg

    here - in this case <TrackId> will be replaced by the value of the first column in the CSV index.
  • music-files=<pathWithPlaceholders> - same as the image path but for the music file. Example:

    music/track-<TrackId>.jpg

All this may sound a little bit confusing, however, again, in most cases there is no need to play with these settings. An example is attached to this post. And - as always - if there are any questions left, feel free to post them in this thread.

_________________

[1] To add a server, select "Add a server containing music files" when clicking on "Settings / My music library / Add source". For Silverjuke <= 2.52beta1, you have to hold down the Shift- and the Ctrl-Key when clicking on the "Add source" button.

[2] Alternatively, this file may be placed in one of the local search directory with the name of the server and all characters beside a-z and 0-9 replaced to a minus, eg. "www-myserver-com.txt". Moreover, for some usual servers, we provide the configuration file on silverjuke.net.
Attachments
music-lib-cfg.txt
This is an example configuration file, please read the comments above.
(543 Bytes) Downloaded 757 times
Last edited by Service-Team on 7. Apr 11, 20:19, edited 4 times in total.

bbrodka
Posts: 16
Joined: 22. Aug 08, 20:41

Re: CSV over HTTP server configuration

Postby bbrodka » 20. Sep 08, 22:32

Are there any recommended apps for automatically scanning and updating the cvs file?

User avatar
Service-Team
Posts: 2446
Joined: 7. Dec 04, 04:48
Location: Germany

Re: CSV over HTTP server configuration

Postby Service-Team » 22. Sep 08, 20:32

No, however, such a script should be creatable with very less scripting (in your favourite language).

Best regards,
Your Silverjuke-Team

Virgus
Posts: 39
Joined: 9. Oct 06, 19:43
Location: Rome, Italy

Re: CSV over HTTP server configuration

Postby Virgus » 24. Sep 08, 21:55

I'm not sure if I understood well, all the cvs data will then be copied to the local db? Or will the local client be able to work just with the cvs and no need for local db?

Regards,
V.

User avatar
Service-Team
Posts: 2446
Joined: 7. Dec 04, 04:48
Location: Germany

Re: CSV over HTTP server configuration

Postby Service-Team » 25. Sep 08, 08:51

Silverjuke reads the information from the CVS and caches them in the local database.

Think of the CVS file as a replacement for the local file system for remote servers.

Best regards,
Your Silverjuke-Team

Guest

Re: CSV over HTTP server configuration

Postby Guest » 24. Jul 09, 16:44

Hi

You supplied us with a configuration for broadchart.com. In fact I think we came up with the dea of server based music feed when we were talking 4 or 5 years ago. However that configuration no longer works.

Can you advise

User avatar
Service-Team
Posts: 2446
Joined: 7. Dec 04, 04:48
Location: Germany

Re: CSV over HTTP server configuration

Postby Service-Team » 25. Jul 09, 15:52

Hello,

we've updated the broadchart configuration file, everything should work well now.

broadchart.png
broadchart.png (329.01 KiB) Viewed 2797 times


By default, the configuration is read from the Silverjuke server, so there is not much you have to do, just remove and re-add your broadchart accout with the correct password.

Best regards,
Your Silverjuke-Team


Return to “Developer Network”