/authelia-validate

Validation check on an Authelia configuration file.

Primary LanguageShellMIT LicenseMIT

Authelia Validate .github/workflows/action-test.yml

This action run a validation check on an authelia configuration file. The output of this command is returned as a Github step summary. Contained in the output is a detailed list of all the configuration errors if any exist.

Inputs

file-path

Required The file path from the repositroy root to the configuration.yml file. Default ./configuration.yml.

version

Required Authelia version used to check the configuration file against. Default v4.37.5.

Enironment Variables

If the configuration file excludes any setting in favor of pulling them from an environment variable then those variables will also need to be set in the action. Any string can be used instead of actual enviroment variables being used with the exception of AUTHELIA_STORAGE_ENCRYPTION_KEY which must be at least 20 characters long. An example of using these dummy environment variables is included in the example below.

Example usage

steps:
  - name: Checkout repository
    uses: actions/checkout@v4

  - name: Validate config
    uses: bubylou/authelia-validate@v3
    env:
      AUTHELIA_JWT_SECRET: test
      AUTHELIA_SESSION_SECRET: test
      AUTHELIA_STORAGE_ENCRYPTION_KEY: twentycharacterslong
    with:
      file-path: ./authelia/configuration.yml
      version: v4.37.5