ContextQMD
Back to Authelia

Budibase

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

4.39.194.0 KB
Original Source

Tested Versions

{{% oidc-common %}}

Assumptions

This example makes the following assumptions:

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

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

{{< sitevar-preferences >}}

Authelia

The following YAML configuration is an example Authelia client configuration for use with Budibase 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: 'budibase'
        client_name: 'Budibase'
        client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng'  # The digest of 'insecure_secret'.
        authorization_policy: 'two_factor'
        require_pkce: false
        pkce_challenge_method: ''
        redirect_uris:
          - 'https://budibase.{{< sitevar name="domain" nojs="example.com" >}}/api/global/auth/oidc/callback'
        scopes:
          - 'openid'
          - 'offline_access'
          - 'profile'
          - 'email'
        response_types:
          - 'code'
        grant_types:
          - 'authorization_code'
          - 'refresh_token'
        access_token_signed_response_alg: 'none'
        userinfo_signed_response_alg: 'none'
        token_endpoint_auth_method: 'client_secret_basic'

Application

To configure Budibase there is one method, using the Web GUI.

Web GUI

To configure Budibase to utilize Authelia as an OpenID Connect 1.0 Provider, use the following instructions:

You may be able to skip steps 1 to 3 by visiting the following URL: https://budibase.{{< sitevar name="domain" nojs="example.com" >}}/builder/portal/settings/organisation

  1. Perform one of the following steps:
    1. Visit https://budibase.{{< sitevar name="domain" nojs="example.com" >}}/builder/portal/settings/organisation
    2. Perform all the following steps to get to the above URL:
      1. Navigate to the Builder Main Page.
      2. Navigate to Settings.
      3. Navigate to Organization.
  2. Configure the following options:
    • Org. name: {{< sitevar name="domain" nojs="example.com" >}}
    • Platform URL: https://budibase.{{< sitevar name="domain" nojs="example.com" >}}
  3. Click Save.
  4. Perform one of the following steps:
    1. Visit https://budibase.{{< sitevar name="domain" nojs="example.com" >}}/builder/portal/settings/auth
    2. Perform all the following steps to get to the above URL:
      1. Navigate to the Builder Main Page.
      2. Navigate to Settings.
      3. Navigate to Auth.
      4. Navigate to OpenID Connect.
  5. Configure the following options:
    • Config URL: https://{{< sitevar name="subdomain-authelia" nojs="auth" >}}.{{< sitevar name="domain" nojs="example.com" >}}/.well-known/openid-configuration
    • Client ID: budibase
    • Client Secret: insecure_secret
    • Name: Authelia
    • Icon: authelia.svg (download available on the authelia branding guide)
  6. Click Save.

{{< figure src="budibase_org.png" alt="Budibase" width="300" >}}

{{< figure src="budibase_auth.png" alt="Budibase" width="300" >}}

See Also