Configuration

This extension has a number of configuration values that can be tweaked. However, the default configuration contains everything to get you up and running, and will usually require only a few modifications to match personal preferences.

Configuration Values

internetarchive/enabled

Whether this extension should be enabled or not.

internetarchive/base_url

Base URL to access the Internet Archive.

internetarchive/collections

A list of collection identifiers to show as top-level directories when browsing. These are also used to limit the search scope when no search base is given by Mopidy clients explicitly.

internetarchive/audio_formats

A list of audio file formats, in order of preference.

This entry contains a list of Internet Archive file formats. By default, only audio formats suitable for streaming are requested. Note that the Internet Archive also contains a large number of high-quality media files in FLAC and other lossless formats, but for sake of bandwidth (both your’s and the Archive’s), it is recommended that you stick to lossy audio formats for streaming through Mopidy.

internetarchive/image_formats

A list of image file formats, in order of preference.

This entry contains a list of Internet Archive file formats to be considered when providing images for Internet Archive items. Note that some Mopidy clients, especially MPD clients, will ignore album art provided by Mopidy-InternetArchive or other Mopidy extensions.

internetarchive/browse_limit

The maximum number of browse results.

This is used to limit the number of items returned when browsing the Internet Archive.

internetarchive/browse_views

When browsing Internet Archive collections (or directories in Mopidy), this provides a list of virtual subdirectories so results can be retrieved using a particular sort order.

The format for each entry is <fieldname> (asc|desc) | <label>, where <label> is a name for the entry to show up in the Mopidy client.

internetarchive/search_limit

The maximum number of search results.

This is used to limit the number of items returned when searching the Internet Archive.

internetarchive/search_order

The sort order used when searching the Internet Archive.

internetarchive/cache_size

The number of Internet Archive items to cache in memory.

internetarchive/cache_ttl

The cache time-to-live in seconds.

internetarchive/retries

The maximum number of retries each HTTP connection should attempt.

internetarchive/timeout

The timeout in seconds for HTTP requests to the Internet Archive.

Sort Order Fields

The sort order for searching and browsing is given as <fieldname> (asc|desc), where <fieldname> is one of:

  • addeddate
  • avg_rating
  • call_number
  • createdate
  • creatorSorter
  • date
  • downloads
  • foldoutcount
  • headerImage
  • identifier
  • imagecount
  • indexdate
  • languageSorter
  • licenseurl
  • month
  • nav_order
  • num_reviews
  • publicdate
  • reviewdate
  • stars
  • titleSorter
  • week
  • year

Default Configuration

For reference, this is the default configuration shipped with Mopidy-InternetArchive release 2.0.3:

[internetarchive]
enabled = true

# archive.org base URL
base_url = http://archive.org

# top-level collections for browsing
collections =
    audio
    etree
    librivoxaudio
    audio_bookspoetry
    audio_tech
    audio_music
    audio_news
    audio_foreign
    audio_podcast
    audio_religion

# audio file formats in order of preference
audio_formats = VBR MP3, 64Kbps MP3

# image file formats in order of preference
image_formats = JPEG, JPEG Thumb

# maximum number of browse results
browse_limit = 100

# list of collection browse views: <fieldname> (asc|desc) | <name>
browse_views =
      downloads desc    | Views
      titleSorter asc   | Title
      publicdate desc   | Date Archived
      date desc         | Date Published
      creatorSorter asc | Creator

# maximum number of search results
search_limit = 20

# sort order for searching: <fieldname> (asc|desc); default is score
search_order =

# number of items to cache
cache_size = 128

# cache time-to-live in seconds
cache_ttl = 86400

# maximum number of HTTP connection retries
retries = 3

# HTTP request timeout in seconds
timeout = 10