Skip to content
v2.18.0GitHub

HomeBox

Sign in to the HomeBox inventory system with Pocket ID.

See the HomeBox OIDC documentation for more configuration options.

  1. In Pocket ID, open Administration → OIDC Clients and click Add OIDC Client.
  2. Enter a name such as HomeBox and add the callback URL https://homebox.example.com/api/v1/users/login/oidc/callback/.
  3. Click Create and copy the Client ID and the Client secret. The client secret is only shown once.
  4. On the client’s Access tab, select the groups that may sign in under Allowed User Groups, or choose All Users.
  1. Add the following environment variables to HomeBox:

    - HBOX_OIDC_ENABLED=true
    - HBOX_OIDC_ISSUER_URL=https://id.example.com
    - HBOX_OIDC_CLIENT_ID=<client-id>
    - HBOX_OIDC_CLIENT_SECRET=<client-secret>
    # Required if behind a reverse proxy so HomeBox detects HTTPS correctly
    - HBOX_OPTIONS_TRUST_PROXY=true
    # Optional: require verified email from Pocket ID
    # - HBOX_OIDC_VERIFY_EMAIL=true
    # Optional: auto-redirect to OIDC login (bypass local login screen)
    # - HBOX_OIDC_AUTO_REDIRECT=true
    # Optional: disable username/password login completely
    # - HBOX_OPTIONS_ALLOW_LOCAL_LOGIN=false
  2. Restart HomeBox.

  3. You should now see a Sign in with OIDC button on the HomeBox login page.