Auth

Internal docs for auth provider modules used by Settings → Authentication.

This section documents the auth provider modules under providers/auth/.

They power Settings → Authentication in the UI.

They are separate from sync modules and adapters.

What an auth provider does

Each provider handles:

  • describing UI fields (manifest())

  • running a flow (start()finish())

  • persisting credentials into /config/config.json

Where tokens live

Auth providers write into cfg["<provider>"] namespaces.

Examples:

  • cfg["plex"]["account_token"]

  • cfg["trakt"]["access_token"], refresh_token, expires_at

  • cfg["simkl"]["access_token"]

Common flows

  • device_pin: show PIN → user approves → poll → save token

  • oauth_code: open auth URL → exchange code → save token

  • api_key: user pastes key → save

  • token: user pastes token → save

Gotchas

  • “Connected” often means “token exists”, not “token is valid”.

  • Switching HTTP ↔ HTTPS breaks OAuth redirect URLs.

Last updated

Was this helpful?