Skip to content

Anatomy of the Config

Joe Schmitt edited this page Jul 2, 2017 · 8 revisions

There are 3 main sections to the alexa-libby config:

  1. "server": This contains basic information about your server. Inside this config are keys for "hostname" and "port". If you set these values here, they will be inherited by configurations for movies and shows. If your providers need different values, you can set them individually in their "server" sections and they'll override these values.

  2. "movies": This contains information about what service you use to track movies. The "provider" field tells Libby what service you use to track movies. Valid values are "couchpotato" and "radarr". Most importantly, you should fill in the "apiKey" field from your service, and a "urlBase" if you use one (you'd know if you did). Finally, if you want a specific quality profile set when adding new media to your library, you can set a "quality" field. Note that the value you set for "quality" must exactly match the quality profile name in your provider.

  3. "shows": Same as movies, but for shows. Valid "provider" field values are "sickbeard" and "sonarr". Make sure you fill in the "apiKey" and "urlBase" if you have one set, and the "quality" field if you want do force a specific quality profile.

If you don't use a provider (for example you only track tv shows and not movies), make sure to delete that entire section of the config, otherwise you'll get an error.

You can see some common configuration setups in Sample Configs.

Artwork

As of Libby v1.2.0, there is now an optional "artwork" section for enabling showing media artwork in an Alexa card. This section has one required field: a "tmdbApiKey". You'll need to fill this out with your own API Key from TMDB in order to get the artwork to load correctly:

  "server": {...},
  "movies": {...},
  "shows": {...},
  "artwork": {
    "tmdbApiKey": "abcdefghijklmnopqrstuvwxyz123456"
  }

Once configured correctly, a card will be displayed for Movies and Shows in the Alexa app (or in the Echo Show if you have one) after checking if a movie or show is already on your list, or after adding a new movie or show.