How to Add An Authentication Plugin to Your Deployment

This document aims to provide some general information regarding Authentication Plugin installation. As each authentication plugin may choose to support extra config options, you should refer to the README.md document of the authentication plugin for complete list of available config options.

1. Add the authentication plugin as a Helm Chart Dependency in your deployment Helm Chart Chart.yaml.

e.g. to add internal authentication plugin, you can:

- name: magda-auth-internal
  version: "2.0.0" # the version of internal authentication plugin
  repository: "oci://ghcr.io/magda-io/charts"
  tags:
    - all
    - magda-auth-internal

1. Turn on the plugin via Helm tags in your deployment Values file.

When adding the plugin as dependency in step 1, we defined two tags all & magda-auth-internal. In helm, you can turn on/off the dependencies via the tags defined. If the dependency is turned of, it won’t be deployed even it’s added as a dependency of your deployment chart.

Therefore, you need to make sure either of the tag is enabled in your deployment Values file.

e.g. you can set magda-auth-internal tag to true under tags section in your deployment Values file like:

tags:
  magda-auth-internal: true

1. (Optional) Config the auth plugin in your deployment Values file.

The complete list of available config option can normally find from the Values section of the authentication plugin’s README.md document.

e.g. You can optionally set the text content below the login form for the internal authentication plugin.

magda-auth-internal:
  authPluginConfig:
    loginFormExtraInfoContent: "Forgot your password? Email [test@test.com](test@test.com)"

1. Config Gatway (in your deployment Values file) to add the auth plugin to Gateway’s plugin list (More details see here)

e.g. You can add internal authentication plugin support to your system as the following:

gateway:
  authPlugins:
    - key: internal
      baseUrl: http://magda-auth-internal