ContextQMD
Back to Authelia

HomeBox

docs/content/integration/openid-connect/clients/homebox/index.md

4.39.193.2 KB
Original Source

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://homebox.{{< sitevar name="domain" nojs="example.com" >}}/
  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: homebox
  • Client Secret: insecure_secret

Some of the values presented in this guide can automatically be replaced with documentation variables.

{{< sitevar-preferences >}}

Configuration

Authelia

The following YAML configuration is an example Authelia client configuration for use with HomeBox which will operate with the application example:

yaml
identity_providers:
  oidc:
    ## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
    ## See: https://www.authelia.com/c/oidc
    clients:
      - client_id: 'homebox'
        client_name: 'homebox'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: true
        pkce_challenge_method: 'S256'
        redirect_uris:
          - 'https://homebox.{{< sitevar name="domain" nojs="example.com" >}}/api/v1/users/login/oidc/callback'
        scopes:
          - 'openid'
          - 'groups'
          - 'email'
          - 'profile'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        token_endpoint_auth_method: 'client_secret_basic'

Application

To configure HomeBox there is one method, using Environment Variables.

Environment Variables

To configure HomeBox to utilize Authelia as an OpenID Connect 1.0 Provider, use the following environment variables in the '.env' file:

Standard
shell
HBOX_OIDC_ENABLED=true
HBOX_OIDC_ISSUER_URL=https://auth.{{< sitevar name="domain" nojs="example.com" >}}
HBOX_OIDC_CLIENT_ID=homebox
HBOX_OIDC_CLIENT_SECRET=insecure_secret
HBOX_OIDC_SCOPE=openid profile email groups
HBOX_OPTIONS_TRUST_PROXY=true # this is only needed if you are running HomeBox behind a reverse proxy
Docker Compose
yaml
services:
  homebox:
    environment:
      HBOX_OIDC_ENABLED: 'true'
      HBOX_OIDC_ISSUER_URL: 'https://auth.{{< sitevar name="domain" nojs="example.com" >}}'
      HBOX_OIDC_CLIENT_ID: 'homebox'
      HBOX_OIDC_CLIENT_SECRET: 'insecure_secret'
      HBOX_OIDC_SCOPE: 'openid profile email groups'
      HBOX_OPTIONS_TRUST_PROXY: 'true' # this is only needed if you are running HomeBox behind a reverse proxy

See Also