Public | Automated Build

Last pushed: 2 years ago
Short Description
Auto-corrected and enhanced SomaFM radio station metadata
Full Description

SomaScrobbler API Server streams SomaFM track
metadata in real-time over socket.io. SomaFM's metadata contains a lot of
errors and typos, so the data is auto-corrected and enhanced using Last.fm's
correction API.

Note: This is also available as a service

SomaFM is probably not too happy if a thousand people poll their API about
several dozen thousand times per day. So if you intend to run this software
locally just for you, it might be better to use
api.somascrobbler.com instead of running your
own.

The service can be used for free as much as you want. There is, however, no
up-time guarantee or any other type of guarantee or warranty. But we try our
best. If you notice that the service is having problems, please just submit an
issue.

Installation

  • Download and install Node.js or io.js. You should use a recent version.
  • Then install the somascrobbler-api package globally (-g) from npm. You
    may have to prefix the sommand with sudo depending on your setup.
npm install somascrobbler-api -g

Configuration

Create a config file "$HOME/.somascrobblerapirc" or "/etc/somascrobblerapirc",
or any other location supported by the rucola
module.

Here's a sample config file:

loglevel = debug

[somafm]
pollinterval = 20000

[lastfm]
apikey = xx123456789012345678901234567890

[server]
address = 0.0.0.0
port = 9987
uri = http://localhost:9987
  • loglevel (string; optional; default: info): The log level. Can be either
    "debug", "info", "warn", or "error".

  • somafm.pollinterval (integer; optional; default: 10000): The number of
    milliseconds to wait between SomaFM API requests.

  • lastfm.apikey (string; optional; default: null): Your Last.fm API key.
    This is required for metadata auto-correction. If omitted metadata will not
    be corrected and contain lots and lots of typos.

  • server.address (string; optional; default: 0.0.0.0): The IP of the interface
    for the web server to listen on. By default it will listen on all
    interfaces.

  • server.port (integer; optional; default: 9987): The port for the web interface
    to listen on.

  • server.uri (string; optional; default: http://localhost:9987): The full public
    URL through which the web interface will be accessible including the port
    number unless you're using one of the default ports.

Configuration options can also be provided through environment variables. For
example, the valirable key for lastfm.apikey would be
SOMASCROBBLERAPI_LASTFM_APIKEY.

Run

somascrobbler-api

Or provide an alternate config file:

somascrobbler-api --config=path/to/theconfig

Additionally, configuration options can be overridden through command-line
arguments:

somascrobbler-api --lastfm-apikey=blabla_my_lasfm_key

Docker

SomaScrobbler API Server is also available as a Docker image. It should work with Docker 1.5 or later.

Pull the image from the registry:

docker pull maxkueng/somascrobbler-api:latest

To run it, provide all non-default configuration options as environment variables:

docker run -d \
  -p 80:9987 \
  -e SOMASCROBBLERAPI_LASTFM_APIKEY=xx123456789012345678901234567890 \
  -e SOMASCROBBLERAPI_SERVER_URI=http://example.com \
  --restart on-failure \
  maxkueng/somascrobbler-api:latest

You can also mount an external config file instead of using environment
variables (or use a combination of both):

docker run -d \
  -p 80:9987 \
  -v /path/to/the/config/file:/etc/somascrobblerapirc \
  --restart on-failure \
  maxkueng/somascrobbler-api:latest

License

MIT License

Copyright (c) 2013 Max Kueng (http://maxkueng.com/)

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Docker Pull Command
Owner
maxkueng
Source Repository

Comments (0)