Skip to content

BookOrbit

Learn more about BookOrbit.

API key authentication requires BookOrbit 3.8.0 or later.

widget:
  type: bookorbit
  url: http://bookorbit.host.or.ip:3000
  username: username # optional, if not using an API key
  password: password # optional, if not using an API key
  key: bookorbitapikey # optional, takes precedence over username/password
  fields: ["books", "authors", "reading", "finished"] # optional

Fields

Allowed fields: ["books", "authors", "series", "storage", "reading", "finished"] (maximum of 4).

Default fields: ["books", "authors", "reading", "finished"].