ContextQMD
Back to Authelia

ROM Manager (RomM)

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

4.39.193.5 KB
Original Source

Tested Versions

{{% oidc-common bugs="claims-hydration" %}}

Assumptions

This example makes the following assumptions:

  • Application Root URL: https://romm.{{< sitevar name="domain" nojs="example.com" >}}/
  • Authelia Root URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/
  • Client ID: romm
  • 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 ROM Manager 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: 'romm'
        client_name: 'ROM Manager'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        public: false
        authorization_policy: 'two_factor'
        require_pkce: false
        pkce_challenge_method: ''
        redirect_uris:
          - 'https://romm.{{< sitevar name="domain" nojs="example.com" >}}/api/oauth/openid'
        scopes:
          - 'openid'
          - 'profile'
          - 'email'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Configuration Escape Hatch

{{% oidc-escape-hatch-claims-hydration client_id="romm" claims="email,email_verified,alt_emails,preferred_username,name" %}}

Application

To configure ROM Manager there is one method, using the Environment Variables.

Environment Variables

To configure ROM Manager to utilize Authelia as an OpenID Connect 1.0 Provider, use the following configuration:

Standard
shell
OIDC_ENABLED=true
OIDC_PROVIDER=authelia
OIDC_CLIENT_ID=romm
OIDC_CLIENT_SECRET=insecure_secret
OIDC_REDIRECT_URI=https://romm.{{< sitevar name="domain" nojs="example.com" >}}/api/oauth/openid
OIDC_SERVER_APPLICATION_URL=https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}
Docker Compose
yaml
services:
  romm:
    environment:
      OIDC_ENABLED: 'true'
      OIDC_PROVIDER: 'authelia'
      OIDC_CLIENT_ID: 'romm'
      OIDC_CLIENT_SECRET: 'insecure_secret'
      OIDC_REDIRECT_URI: 'https://romm.{{< sitevar name="domain" nojs="example.com" >}}/api/oauth/openid'
      OIDC_SERVER_APPLICATION_URL: 'https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}'

See Also