RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' into feat-settings-ui

feat-otp-verification
James Elliott 2023-01-27 11:27:12 +11:00 committed by GitHub
parent 7d17c39c52 b153db66bf
commit 4bed5d2461
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
56 changed files with 555 additions and 386 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/authelia-gen/cmd_code.go
View File

@ -177,7 +177,7 @@ func codeKeysRunE(cmd *cobra.Command, args []string) (err error) {
data := tmplConfigurationKeysData{ data := tmplConfigurationKeysData{
Timestamp: time.Now(), Timestamp: time.Now(),
Keys: readTags("", reflect.TypeOf(schema.Configuration{})), Keys: readTags("", reflect.TypeOf(schema.Configuration{}), false),
} }
if root, err = cmd.Flags().GetString(cmdFlagRoot); err != nil { if root, err = cmd.Flags().GetString(cmdFlagRoot); err != nil {

2
cmd/authelia-gen/cmd_commit_msg.go
View File

@ -110,7 +110,7 @@ func commitLintRunE(cmd *cobra.Command, args []string) (err error) {
return err return err
} }
if pathCommitLintConfig, err = cmd.Flags().GetString(cmdFlagFileConfigCommitLint); err != nil { if pathCommitLintConfig, err = getPFlagPath(cmd.Flags(), cmdFlagRoot, cmdFlagWeb, cmdFlagFileConfigCommitLint); err != nil {
return err return err
} }

26
cmd/authelia-gen/cmd_docs_data.go
View File

@ -51,6 +51,26 @@ func docsDataMiscRunE(cmd *cobra.Command, args []string) (err error) {
data.CSP.TemplateDefault = strings.ReplaceAll(data.CSP.TemplateDefault, "%s", codeCSPNonce) data.CSP.TemplateDefault = strings.ReplaceAll(data.CSP.TemplateDefault, "%s", codeCSPNonce)
data.CSP.TemplateDevelopment = strings.ReplaceAll(data.CSP.TemplateDevelopment, "%s", codeCSPNonce) data.CSP.TemplateDevelopment = strings.ReplaceAll(data.CSP.TemplateDevelopment, "%s", codeCSPNonce)
var (
pathPackageJSON string
dataPackageJSON []byte
packageJSON PackageJSON
)
if pathPackageJSON, err = getPFlagPath(cmd.Flags(), cmdFlagRoot, cmdFlagWeb, cmdFlagFileWebPackage); err != nil {
return err
}
if dataPackageJSON, err = os.ReadFile(pathPackageJSON); err != nil {
return err
}
if err = json.Unmarshal(dataPackageJSON, &packageJSON); err != nil {
return fmt.Errorf("failed to unmarshall package.json: %w", err)
}
data.Latest = packageJSON.Version
var ( var (
outputPath string outputPath string
dataJSON []byte dataJSON []byte
@ -89,13 +109,9 @@ func docsKeysRunE(cmd *cobra.Command, args []string) (err error) {
data []ConfigurationKey data []ConfigurationKey
) )
keys := readTags("", reflect.TypeOf(schema.Configuration{})) keys := readTags("", reflect.TypeOf(schema.Configuration{}), true)
for _, key := range keys { for _, key := range keys {
if strings.Contains(key, "[]") {
continue
}
ck := ConfigurationKey{ ck := ConfigurationKey{
Path: key, Path: key,
Secret: configuration.IsSecretKey(key), Secret: configuration.IsSecretKey(key),

2
cmd/authelia-gen/cmd_locales.go
View File

@ -42,7 +42,7 @@ func localesRunE(cmd *cobra.Command, args []string) (err error) {
return err return err
} }
if pathWebI18NIndex, err = cmd.Flags().GetString(cmdFlagFileWebI18N); err != nil { if pathWebI18NIndex, err = getPFlagPath(cmd.Flags(), cmdFlagRoot, cmdFlagWeb, cmdFlagFileWebI18N); err != nil {
return err return err
} }

4
cmd/authelia-gen/cmd_root.go
View File

@ -26,12 +26,14 @@ func newRootCmd() *cobra.Command {
cmd.PersistentFlags().StringP(cmdFlagCwd, "C", "", "Sets the CWD for git commands") cmd.PersistentFlags().StringP(cmdFlagCwd, "C", "", "Sets the CWD for git commands")
cmd.PersistentFlags().StringP(cmdFlagRoot, "d", dirCurrent, "The repository root") cmd.PersistentFlags().StringP(cmdFlagRoot, "d", dirCurrent, "The repository root")
cmd.PersistentFlags().String(cmdFlagWeb, dirWeb, "The repository web directory in relation to the root directory")
cmd.PersistentFlags().StringSliceP(cmdFlagExclude, "X", nil, "Sets the names of excluded generators") cmd.PersistentFlags().StringSliceP(cmdFlagExclude, "X", nil, "Sets the names of excluded generators")
cmd.PersistentFlags().String(cmdFlagFeatureRequest, fileGitHubIssueTemplateFR, "Sets the path of the feature request issue template file") cmd.PersistentFlags().String(cmdFlagFeatureRequest, fileGitHubIssueTemplateFR, "Sets the path of the feature request issue template file")
cmd.PersistentFlags().String(cmdFlagBugReport, fileGitHubIssueTemplateBR, "Sets the path of the bug report issue template file") cmd.PersistentFlags().String(cmdFlagBugReport, fileGitHubIssueTemplateBR, "Sets the path of the bug report issue template file")
cmd.PersistentFlags().Int(cmdFlagVersions, 5, "the maximum number of minor versions to list in output templates") cmd.PersistentFlags().Int(cmdFlagVersions, 5, "the maximum number of minor versions to list in output templates")
cmd.PersistentFlags().String(cmdFlagDirLocales, dirLocales, "The locales directory in relation to the root") cmd.PersistentFlags().String(cmdFlagDirLocales, dirLocales, "The locales directory in relation to the root")
cmd.PersistentFlags().String(cmdFlagFileWebI18N, fileWebI18NIndex, "The i18n typescript configuration file in relation to the root") cmd.PersistentFlags().String(cmdFlagFileWebI18N, fileWebI18NIndex, "The i18n typescript configuration file in relation to the web directory")
cmd.PersistentFlags().String(cmdFlagFileWebPackage, fileWebPackage, "The node package configuration file in relation to the web directory")
cmd.PersistentFlags().String(cmdFlagDocsDataLanguages, fileDocsDataLanguages, "The languages docs data file in relation to the docs data folder") cmd.PersistentFlags().String(cmdFlagDocsDataLanguages, fileDocsDataLanguages, "The languages docs data file in relation to the docs data folder")
cmd.PersistentFlags().String(cmdFlagDocsDataMisc, fileDocsDataMisc, "The misc docs data file in relation to the docs data folder") cmd.PersistentFlags().String(cmdFlagDocsDataMisc, fileDocsDataMisc, "The misc docs data file in relation to the docs data folder")
cmd.PersistentFlags().String(cmdFlagDocsCLIReference, dirDocsCLIReference, "The directory to store the markdown in") cmd.PersistentFlags().String(cmdFlagDocsCLIReference, dirDocsCLIReference, "The directory to store the markdown in")

25
cmd/authelia-gen/const.go
View File

@ -3,12 +3,14 @@ package main
const ( const (
dirCurrent = "./" dirCurrent = "./"
dirLocales = "internal/server/locales" dirLocales = "internal/server/locales"
dirWeb = "web"
subPathCmd = "cmd" subPathCmd = "cmd"
subPathInternal = "internal" subPathInternal = "internal"
fileCICommitLintConfig = "web/.commitlintrc.js" fileCICommitLintConfig = ".commitlintrc.js"
fileWebI18NIndex = "web/src/i18n/index.ts" fileWebI18NIndex = "src/i18n/index.ts"
fileWebPackage = "package.json"
fileDocsCommitMessageGuidelines = "docs/content/en/contributing/guidelines/commit-message.md" fileDocsCommitMessageGuidelines = "docs/content/en/contributing/guidelines/commit-message.md"
@ -68,27 +70,30 @@ const (
const ( const (
cmdFlagRoot = "dir.root" cmdFlagRoot = "dir.root"
cmdFlagExclude = "exclude" cmdFlagWeb = "dir.web"
cmdFlagVersions = "versions" cmdFlagFileWebI18N = "file.web.i18n"
cmdFlagFileWebPackage = "file.web.package"
cmdFlagDocs = "dir.docs"
cmdFlagDirLocales = "dir.locales" cmdFlagDirLocales = "dir.locales"
cmdFlagDocsCLIReference = "dir.docs.cli-reference" cmdFlagDocsCLIReference = "dir.docs.cli-reference"
cmdFlagDocsContent = "dir.docs.content" cmdFlagDocsContent = "dir.docs.content"
cmdFlagDocsData = "dir.docs.data" cmdFlagDocsData = "dir.docs.data"
cmdFlagDocs = "dir.docs"
cmdFlagDocsDataLanguages = "file.docs.data.languages"
cmdFlagDocsDataMisc = "file.docs.data.misc" cmdFlagDocsDataMisc = "file.docs.data.misc"
cmdFlagDocsDataKeys = "file.docs.data.keys" cmdFlagDocsDataKeys = "file.docs.data.keys"
cmdFlagCwd = "cwd" cmdFlagDocsDataLanguages = "file.docs.data.languages"
cmdFlagFileConfigKeys = "file.configuration-keys" cmdFlagFileConfigKeys = "file.configuration-keys"
cmdFlagFileScriptsGen = "file.scripts.gen" cmdFlagFileScriptsGen = "file.scripts.gen"
cmdFlagFileServerGenerated = "file.server.generated" cmdFlagFileServerGenerated = "file.server.generated"
cmdFlagFileConfigCommitLint = "file.commit-lint-config" cmdFlagFileConfigCommitLint = "file.commit-lint-config"
cmdFlagFileDocsCommitMsgGuidelines = "file.docs-commit-msg-guidelines" cmdFlagFileDocsCommitMsgGuidelines = "file.docs-commit-msg-guidelines"
cmdFlagFileWebI18N = "file.web-i18n"
cmdFlagFeatureRequest = "file.feature-request" cmdFlagFeatureRequest = "file.feature-request"
cmdFlagBugReport = "file.bug-report" cmdFlagBugReport = "file.bug-report"
cmdFlagPackageConfigKeys = "package.configuration.keys"
cmdFlagPackageScriptsGen = "package.scripts.gen" cmdFlagExclude = "exclude"
cmdFlagVersions = "versions"
cmdFlagCwd = "cwd"
cmdFlagPackageConfigKeys = "package.configuration.keys"
cmdFlagPackageScriptsGen = "package.scripts.gen"
) )
const ( const (

28
cmd/authelia-gen/helpers.go
View File

@ -83,12 +83,16 @@ func containsType(needle reflect.Type, haystack []reflect.Type) (contains bool)
} }
//nolint:gocyclo //nolint:gocyclo
func readTags(prefix string, t reflect.Type) (tags []string) { func readTags(prefix string, t reflect.Type, envSkip bool) (tags []string) {
tags = make([]string, 0) tags = make([]string, 0)
if envSkip && (t.Kind() == reflect.Slice || t.Kind() == reflect.Map) {
return
}
if t.Kind() != reflect.Struct { if t.Kind() != reflect.Struct {
if t.Kind() == reflect.Slice { if t.Kind() == reflect.Slice {
tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, "", true, false), t.Elem())...) tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, "", true, false), t.Elem(), envSkip)...)
} }
return return
@ -108,34 +112,42 @@ func readTags(prefix string, t reflect.Type) (tags []string) {
switch kind := field.Type.Kind(); kind { switch kind := field.Type.Kind(); kind {
case reflect.Struct: case reflect.Struct:
if !containsType(field.Type, decodedTypes) { if !containsType(field.Type, decodedTypes) {
tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, false, false), field.Type)...) tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, false, false), field.Type, envSkip)...)
continue continue
} }
case reflect.Slice, reflect.Map: case reflect.Slice, reflect.Map:
if envSkip {
continue
}
switch field.Type.Elem().Kind() { switch field.Type.Elem().Kind() {
case reflect.Struct: case reflect.Struct:
if !containsType(field.Type.Elem(), decodedTypes) { if !containsType(field.Type.Elem(), decodedTypes) {
tags = append(tags, getKeyNameFromTagAndPrefix(prefix, tag, false, false)) tags = append(tags, getKeyNameFromTagAndPrefix(prefix, tag, false, false))
tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, kind == reflect.Slice, kind == reflect.Map), field.Type.Elem())...) tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, kind == reflect.Slice, kind == reflect.Map), field.Type.Elem(), envSkip)...)
continue continue
} }
case reflect.Slice: case reflect.Slice:
tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, kind == reflect.Slice, kind == reflect.Map), field.Type.Elem())...) tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, kind == reflect.Slice, kind == reflect.Map), field.Type.Elem(), envSkip)...)
} }
case reflect.Ptr: case reflect.Ptr:
switch field.Type.Elem().Kind() { switch field.Type.Elem().Kind() {
case reflect.Struct: case reflect.Struct:
if !containsType(field.Type.Elem(), decodedTypes) { if !containsType(field.Type.Elem(), decodedTypes) {
tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, false, false), field.Type.Elem())...) tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, false, false), field.Type.Elem(), envSkip)...)
continue continue
} }
case reflect.Slice: case reflect.Slice, reflect.Map:
if envSkip {
continue
}
if field.Type.Elem().Elem().Kind() == reflect.Struct { if field.Type.Elem().Elem().Kind() == reflect.Struct {
if !containsType(field.Type.Elem(), decodedTypes) { if !containsType(field.Type.Elem(), decodedTypes) {
tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, true, false), field.Type.Elem())...) tags = append(tags, readTags(getKeyNameFromTagAndPrefix(prefix, tag, true, false), field.Type.Elem(), envSkip)...)
continue continue
} }

9
cmd/authelia-gen/types.go
View File

@ -32,7 +32,8 @@ type GitHubTagsJSON struct {
// DocsDataMisc represents the docs misc data schema. // DocsDataMisc represents the docs misc data schema.
type DocsDataMisc struct { type DocsDataMisc struct {
CSP TemplateCSP `json:"csp"` CSP TemplateCSP `json:"csp"`
Latest string `json:"latest"`
} }
// TemplateCSP represents the CSP template vars. // TemplateCSP represents the CSP template vars.
@ -139,7 +140,13 @@ func (t labelType) String() string {
return fmt.Sprintf("%s/%s", labelAreaPrefixType, labelTypeDescriptions[t]) return fmt.Sprintf("%s/%s", labelAreaPrefixType, labelTypeDescriptions[t])
} }
// CSPValue represents individual CSP values.
type CSPValue struct { type CSPValue struct {
Name string Name string
Value string Value string
} }
// PackageJSON represents a NPM package.json file.
type PackageJSON struct {
Version string `json:"version"`
}

55
docs/content/en/blog/pre-release-notes-4.38/index.md
View File

@ -3,7 +3,7 @@ title: "4.38: Pre-Release Notes"
description: "Authelia 4.38 is just around the corner. This version has several additional features and improvements to existing features. In this blog post we'll discuss the new features and roughly what it means for users." description: "Authelia 4.38 is just around the corner. This version has several additional features and improvements to existing features. In this blog post we'll discuss the new features and roughly what it means for users."
lead: "Pre-Release Notes for 4.38" lead: "Pre-Release Notes for 4.38"
excerpt: "Authelia 4.38 is just around the corner. This version has several additional features and improvements to existing features. In this blog post we'll discuss the new features and roughly what it means for users." excerpt: "Authelia 4.38 is just around the corner. This version has several additional features and improvements to existing features. In this blog post we'll discuss the new features and roughly what it means for users."
date: 2023-01-18T19:47:09+10:00 date: 2023-01-21T00:18:00+11:00
draft: false draft: false
images: [] images: []
categories: ["News", "Release Notes"] categories: ["News", "Release Notes"]
@ -37,6 +37,50 @@ necessary as several new features will not be available or even possible without
will be publishing some guides on making these adjustments on the blog in the near future, including an FAQ catered to will be publishing some guides on making these adjustments on the blog in the near future, including an FAQ catered to
specific scenarios._ specific scenarios._
## Builds
The following contains information on getting access to the pre-production builds of 4.38.0.
_**Note:** We strongly recommend people who wish to try the beta builds make backups of their proxy configuration,
authelia configuration, and authelia database prior to attempting to do so._
### 4.38.0-beta1
Notable Missing Features from this build:
- OpenID Connect 1.0 PAR
- Multi-Device Webauthn
- Device Registration OTP
- Container Images:
- [docker.io/authelia/authelia:v4.38.0-beta1](https://hub.docker.com/layers/authelia/authelia/v4.38.0-beta1/images/sha256-53faae6b6a0616f71f1f77069237d92969433b0037b9825be12852e013812bd0?context=explore)
- [ghcr.io/authelia/authelia:v4.38.0-beta1](https://github.com/authelia/authelia/pkgs/container/authelia/65909221?tag=v4.38.0-beta1)
- [Binaries](https://buildkite.com/authelia/authelia/builds/18261)
- [Documentation](https://deploy-preview-4828--authelia-staging.netlify.app/)
Major Documentation Changes:
- [LDAP](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/configuration/first-factor/ldap/)
- [Reference Guide](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/reference/guides/ldap/)
- [Server](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/configuration/miscellaneous/server/)
- [Authz Endpoints](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/configuration/miscellaneous/server-endpoints-authz/)
- [Reference Guide](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/reference/guides/proxy-authorization/)
- [Session](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/configuration/session/introduction/)
- [Configuration Files](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/configuration/methods/files/)
- [Configuration Files](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/configuration/methods/files/)
- [Proxy Integration](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/introduction/)
- [Caddy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/caddy/)
- [Envoy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/envoy/)
- [HAProxy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/haproxy/)
- [HAProxy](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/haproxy/)
- [NGINX](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/nginx/)
- [Traefik](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/proxies/traefik/)
- [Kubernetes Integration](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/kubernetes/introduction/)
- [Traefik Ingress](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/kubernetes/traefik-ingress/)
- [Istio](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/kubernetes/istio/)
- [NGINX Ingress](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/integration/kubernetes/nginx-ingress/)
- [Templating Reference Guide](https://63d20934fa12200009e12cbf--authelia-staging.netlify.app/reference/guides/templating/)
## OpenID Connect 1.0 ## OpenID Connect 1.0
As part of our ongoing effort for comprehensive support for [OpenID Connect 1.0] we'll be introducing several important As part of our ongoing effort for comprehensive support for [OpenID Connect 1.0] we'll be introducing several important
@ -141,6 +185,8 @@ In addition to being able to customize them you can create your own, and complet
implementations in the process. Use of these new endpoints will require reconfiguration of your proxy, we plan to implementations in the process. Use of these new endpoints will require reconfiguration of your proxy, we plan to
release a guide for each proxy. release a guide for each proxy.
See the server authz endpoints docs and reference guide in the [builds](#builds) section for more information.
## User Dashboard / Control Panel ## User Dashboard / Control Panel
As part of our ongoing effort for comprehensive support for a User Dashboard / Control Panel we'll be introducing As part of our ongoing effort for comprehensive support for a User Dashboard / Control Panel we'll be introducing
@ -184,6 +230,8 @@ second will use the go template engine in a very similar way to how Helm operate
As these features are experimental they may break, be removed, or otherwise not operate as expected. However most of our As these features are experimental they may break, be removed, or otherwise not operate as expected. However most of our
testing indicates they're incredibly solid. testing indicates they're incredibly solid.
See the templating reference guide in the [builds](#builds) section for more information.
##### LDAP Implementation ##### LDAP Implementation
Several new LDAP implementations which provide defaults are being introduced in this version to assist users in Several new LDAP implementations which provide defaults are being introduced in this version to assist users in
@ -207,3 +255,8 @@ unified in this release.
We'll be introducing a feature which allows administrators to more easily comply with the GDPR which optionally shows a We'll be introducing a feature which allows administrators to more easily comply with the GDPR which optionally shows a
link to their individual privacy policy on the frontend, and optionally requires users to accept it before using link to their individual privacy policy on the frontend, and optionally requires users to accept it before using
Authelia. Authelia.
##### LDAP Implementations
This release adds several LDAP implementations into our existing set. See the reference guide in the [builds](#builds)
section for more information.

2
docs/content/en/configuration/identity-providers/introduction.md
View File

@ -16,4 +16,4 @@ aliases:
## OpenID Connect ## OpenID Connect
The only identity provider implementation supported at this time is [OpenID Connect](open-id-connect.md). The only identity provider implementation supported at this time is [OpenID Connect 1.0](open-id-connect.md).

29
docs/content/en/configuration/identity-providers/open-id-connect.md
View File

@ -1,7 +1,7 @@
--- ---
title: "OpenID Connect" title: "OpenID Connect"
description: "OpenID Connect Configuration" description: "OpenID Connect Configuration"
lead: "Authelia can operate as an OpenID Connect provider. This section describes how to configure this." lead: "Authelia can operate as an OpenID Connect 1.0 Provider. This section describes how to configure this."
date: 2022-06-15T17:51:47+10:00 date: 2022-06-15T17:51:47+10:00
draft: false draft: false
images: [] images: []
@ -15,13 +15,14 @@ aliases:
- /docs/configuration/identity-providers/oidc.html - /docs/configuration/identity-providers/oidc.html
--- ---
__Authelia__ currently supports the [OpenID Connect] OP role as a [__beta__](../../roadmap/active/openid-connect.md) __Authelia__ currently supports the [OpenID Connect 1.0] Provider role as an open
feature. The OP role is the [OpenID Connect] Provider role, not the Relying Party or RP role. This means other [__beta__](../../roadmap/active/openid-connect.md) feature. We currently do not support the [OpenID Connect 1.0] Relying
applications that implement the [OpenID Connect] RP role can use Authelia as an authentication and authorization backend Party role. This means other applications that implement the [OpenID Connect 1.0] Relying Party role can use Authelia as
similar to how you may use social media or development platforms for login. an [OpenID Connect 1.0] Provider similar to how you may use social media or development platforms for login.
The Relying Party role is the role which allows an application to use GitHub, Google, or other [OpenID Connect] The [OpenID Connect 1.0] Relying Party role is the role which allows an application to use GitHub, Google, or other
providers for authentication and authorization. We do not intend to support this functionality at this moment in time. [OpenID Connect 1.0] Providers for authentication and authorization. We do not intend to support this functionality at
this moment in time.
More information about the beta can be found in the [roadmap](../../roadmap/active/openid-connect.md). More information about the beta can be found in the [roadmap](../../roadmap/active/openid-connect.md).
@ -165,7 +166,7 @@ with 64 or more characters.
{{< confkey type="string" required="no" >}} {{< confkey type="string" required="no" >}}
The certificate chain/bundle to be used with the [issuer_private_key](#issuer_private_key) DER base64 ([RFC4648]) The certificate chain/bundle to be used with the [issuer_private_key](#issuer_private_key) DER base64 ([RFC4648])
encoded PEM format used to sign/encrypt the [OpenID Connect] [JWT]'s. When configured it enables the [x5c] and [x5t] encoded PEM format used to sign/encrypt the [OpenID Connect 1.0] [JWT]'s. When configured it enables the [x5c] and [x5t]
JSON key's in the JWKs [Discoverable Endpoint](../../integration/openid-connect/introduction.md#discoverable-endpoints) JSON key's in the JWKs [Discoverable Endpoint](../../integration/openid-connect/introduction.md#discoverable-endpoints)
as per [RFC7517]. as per [RFC7517].
@ -184,7 +185,7 @@ certificate immediately following it if present.
*__Important Note:__ This can also be defined using a [secret](../methods/secrets.md) which is __strongly recommended__ *__Important Note:__ This can also be defined using a [secret](../methods/secrets.md) which is __strongly recommended__
especially for containerized deployments.* especially for containerized deployments.*
The private key used to sign/encrypt the [OpenID Connect] issued [JWT]'s. The key must be generated by the administrator The private key used to sign/encrypt the [OpenID Connect 1.0] issued [JWT]'s. The key must be generated by the administrator
and can be done by following the and can be done by following the
[Generating an RSA Keypair](../../reference/guides/generating-secure-values.md#generating-an-rsa-keypair) guide. [Generating an RSA Keypair](../../reference/guides/generating-secure-values.md#generating-an-rsa-keypair) guide.
@ -273,7 +274,7 @@ method instead.
### cors ### cors
Some [OpenID Connect] Endpoints need to allow cross-origin resource sharing, however some are optional. This section allows Some [OpenID Connect 1.0] Endpoints need to allow cross-origin resource sharing, however some are optional. This section allows
you to configure the optional parts. We reply with CORS headers when the request includes the Origin header. you to configure the optional parts. We reply with CORS headers when the request includes the Origin header.
#### endpoints #### endpoints
@ -298,7 +299,7 @@ A list of permitted origins.
Any origin with https is permitted unless this option is configured or the Any origin with https is permitted unless this option is configured or the
[allowed_origins_from_client_redirect_uris](#allowed_origins_from_client_redirect_uris) option is enabled. This means [allowed_origins_from_client_redirect_uris](#allowed_origins_from_client_redirect_uris) option is enabled. This means
you must configure this option manually if you want http endpoints to be permitted to make cross-origin requests to the you must configure this option manually if you want http endpoints to be permitted to make cross-origin requests to the
[OpenID Connect] endpoints, however this is not recommended. [OpenID Connect 1.0] endpoints, however this is not recommended.
Origins must only have the scheme, hostname and port, they may not have a trailing slash or path. Origins must only have the scheme, hostname and port, they may not have a trailing slash or path.
@ -386,7 +387,7 @@ the lookup of the subject identifier.
2. any client with a differing sector identifier. 2. any client with a differing sector identifier.
In specific but limited scenarios this option is beneficial for privacy reasons. In particular this is useful when the In specific but limited scenarios this option is beneficial for privacy reasons. In particular this is useful when the
party utilizing the *Authelia* [OpenID Connect] Authorization Server is foreign and not controlled by the user. It would party utilizing the *Authelia* [OpenID Connect 1.0] Authorization Server is foreign and not controlled by the user. It would
prevent the third party utilizing the subject identifier with another third party in order to track the user. prevent the third party utilizing the subject identifier with another third party in order to track the user.
Keep in mind depending on the other claims they may still be able to perform this tracking and it is not a silver Keep in mind depending on the other claims they may still be able to perform this tracking and it is not a silver
@ -524,11 +525,11 @@ match exactly with the granted scopes/audience.
## Integration ## Integration
To integrate Authelia's [OpenID Connect] implementation with a relying party please see the To integrate Authelia's [OpenID Connect 1.0] implementation with a relying party please see the
[integration docs](../../integration/openid-connect/introduction.md). [integration docs](../../integration/openid-connect/introduction.md).
[token lifespan]: https://docs.apigee.com/api-platform/antipatterns/oauth-long-expiration [token lifespan]: https://docs.apigee.com/api-platform/antipatterns/oauth-long-expiration
[OpenID Connect]: https://openid.net/connect/ [OpenID Connect 1.0]: https://openid.net/connect/
[JWT]: https://www.rfc-editor.org/rfc/rfc7519.html [JWT]: https://www.rfc-editor.org/rfc/rfc7519.html
[RFC6234]: https://www.rfc-editor.org/rfc/rfc6234.html [RFC6234]: https://www.rfc-editor.org/rfc/rfc6234.html
[RFC4648]: https://www.rfc-editor.org/rfc/rfc4648.html [RFC4648]: https://www.rfc-editor.org/rfc/rfc4648.html

5
docs/content/en/configuration/methods/environment.md
View File

@ -15,8 +15,9 @@ toc: true
Environment variables are applied after the configuration file meaning anything specified as part of the environment Environment variables are applied after the configuration file meaning anything specified as part of the environment
overrides the configuration files. overrides the configuration files.
*__Please Note:__ It is not possible to configure the access control rules section or OpenID Connect identity provider *__Please Note:__ It is not possible to configure several sections at this time, these include but may not be
clients section using environment variables at this time.* limited to the rules section in access control, the clients section in the OpenID Connect identity provider, the cookies
section of in session, and the authz section in the server endpoints.*
## Prefix ## Prefix

2
docs/content/en/configuration/miscellaneous/privacy-policy.md
View File

@ -2,7 +2,7 @@
title: "Privacy Policy" title: "Privacy Policy"
description: "Privacy Policy Configuration." description: "Privacy Policy Configuration."
lead: "This describes a section of the configuration for enabling a Privacy Policy link display." lead: "This describes a section of the configuration for enabling a Privacy Policy link display."
date: 2020-02-29T01:43:59+01:00 date: 2023-01-22T19:58:07+11:00
draft: false draft: false
images: [] images: []
menu: menu:

2
docs/content/en/configuration/miscellaneous/server-endpoints-authz.md
View File

@ -2,7 +2,7 @@
title: "Server Authz Endpoints" title: "Server Authz Endpoints"
description: "Configuring the Server Authz Endpoint Settings." description: "Configuring the Server Authz Endpoint Settings."
lead: "Authelia supports several authorization endpoints on the internal webserver. This section describes how to configure and tune them." lead: "Authelia supports several authorization endpoints on the internal webserver. This section describes how to configure and tune them."
date: 2022-10-31T09:33:39+11:00 date: 2023-01-25T20:36:40+11:00
draft: false draft: false
images: [] images: []
menu: menu:

4
docs/content/en/integration/openid-connect/apache-guacamole/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Apache Guacamole] to utilize Authelia as an [OpenID Connect] Provider use the following configuration: To configure [Apache Guacamole] to utilize Authelia as an [OpenID Connect 1.0] Provider use the following configuration:
```yaml ```yaml
openid-client-id: guacamole openid-client-id: guacamole
@ -89,7 +89,7 @@ The following YAML configuration is an example __Authelia__
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Apache Guacamole]: https://guacamole.apache.org/ [Apache Guacamole]: https://guacamole.apache.org/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/argocd/index.md
View File

@ -45,7 +45,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Argo CD] to utilize Authelia as an [OpenID Connect] Provider use the following configuration: To configure [Argo CD] to utilize Authelia as an [OpenID Connect 1.0] Provider use the following configuration:
```yaml ```yaml
name: Authelia name: Authelia
@ -101,7 +101,7 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Argo CD]: https://argo-cd.readthedocs.io/en/stable/ [Argo CD]: https://argo-cd.readthedocs.io/en/stable/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/bookstack/index.md
View File

@ -50,7 +50,7 @@ the secret or URL encode the secret yourself.*
### Application ### Application
To configure [BookStack] to utilize Authelia as an [OpenID Connect] Provider: To configure [BookStack] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Edit your .env file 1. Edit your .env file
2. Set the following values: 2. Set the following values:
@ -89,4 +89,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[BookStack]: https://www.bookstackapp.com/ [BookStack]: https://www.bookstackapp.com/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/cloudflare-zerotrust/index.md
View File

@ -52,7 +52,7 @@ characters for the secret or URL encode the secret yourself.*
means that the URL's are accessible to foreign clients on the internet. There may be a way to configure this without means that the URL's are accessible to foreign clients on the internet. There may be a way to configure this without
accessibility to foreign clients on the internet on Cloudflare's end but this is beyond the scope of this document.* accessibility to foreign clients on the internet on Cloudflare's end but this is beyond the scope of this document.*
To configure [Cloudflare Zero Trust] to utilize Authelia as an [OpenID Connect] Provider: To configure [Cloudflare Zero Trust] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Visit the [Cloudflare Zero Trust Dashboard](https://dash.teams.cloudflare.com) 1. Visit the [Cloudflare Zero Trust Dashboard](https://dash.teams.cloudflare.com)
2. Visit `Settings` 2. Visit `Settings`
@ -98,4 +98,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Cloudflare]: https://www.cloudflare.com/ [Cloudflare]: https://www.cloudflare.com/
[Cloudflare Zero Trust]: https://www.cloudflare.com/products/zero-trust/ [Cloudflare Zero Trust]: https://www.cloudflare.com/products/zero-trust/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

6
docs/content/en/integration/openid-connect/gitea/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Gitea] to utilize Authelia as an [OpenID Connect] Provider: To configure [Gitea] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Expand User Options 1. Expand User Options
2. Visit Site Administration 2. Visit Site Administration
@ -59,7 +59,7 @@ To configure [Gitea] to utilize Authelia as an [OpenID Connect] Provider:
{{< figure src="gitea.png" alt="Gitea" width="300" >}} {{< figure src="gitea.png" alt="Gitea" width="300" >}}
To configure [Gitea] to perform automatic user creation for the `auth.example.com` domain via [OpenID Connect]: To configure [Gitea] to perform automatic user creation for the `auth.example.com` domain via [OpenID Connect 1.0]:
1. Edit the following values in the [Gitea] `app.ini`: 1. Edit the following values in the [Gitea] `app.ini`:
```ini ```ini
@ -105,4 +105,4 @@ will operate with the above example:
- [Authelia]: https://www.authelia.com - [Authelia]: https://www.authelia.com
[Gitea]: https://gitea.io/ [Gitea]: https://gitea.io/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

6
docs/content/en/integration/openid-connect/gitlab/index.md
View File

@ -44,9 +44,9 @@ This example makes the following assumptions:
### Application ### Application
To configure [GitLab] to utilize Authelia as an [OpenID Connect] Provider: To configure [GitLab] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Add the Omnibus [OpenID Connect] OmniAuth configuration to `gitlab.rb`: 1. Add the Omnibus [OpenID Connect 1.0] OmniAuth configuration to `gitlab.rb`:
```ruby ```ruby
gitlab_rails['omniauth_providers'] = [ gitlab_rails['omniauth_providers'] = [
@ -101,4 +101,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[GitLab]: https://about.gitlab.com/ [GitLab]: https://about.gitlab.com/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/grafana/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Grafana] to utilize Authelia as an [OpenID Connect] Provider you have two effective options: To configure [Grafana] to utilize Authelia as an [OpenID Connect 1.0] Provider you have two effective options:
#### Configuration File #### Configuration File
@ -119,4 +119,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Grafana]: https://grafana.com/ [Grafana]: https://grafana.com/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/harbor/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Harbor] to utilize Authelia as an [OpenID Connect] Provider: To configure [Harbor] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Visit Administration 1. Visit Administration
2. Visit Configuration 2. Visit Configuration
@ -92,4 +92,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Harbor]: https://goharbor.io/ [Harbor]: https://goharbor.io/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/hashicorp-vault/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [HashiCorp Vault] to utilize Authelia as an [OpenID Connect] Provider please see the links in the To configure [HashiCorp Vault] to utilize Authelia as an [OpenID Connect 1.0] Provider please see the links in the
[see also](#see-also) section. [see also](#see-also) section.
### Authelia ### Authelia
@ -77,4 +77,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[HashiCorp Vault]: https://www.vaultproject.io/ [HashiCorp Vault]: https://www.vaultproject.io/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

15
docs/content/en/integration/openid-connect/introduction.md
View File

@ -14,21 +14,22 @@ aliases:
- /docs/community/oidc-integrations.html - /docs/community/oidc-integrations.html
--- ---
Authelia supports [OpenID Connect] as part of an open beta. This section details implementation specifics that can be Authelia can act as an [OpenID Connect 1.0] Provider as part of an open beta. This section details implementation
used for integrating Authelia with relying parties, as well as specific documentation for some relying parties. specifics that can be used for integrating Authelia with an [OpenID Connect 1.0] Relying Party, as well as specific
documentation for some [OpenID Connect 1.0] Relying Party implementations.
See the [configuration documentation](../../configuration/identity-providers/open-id-connect.md) for information on how See the [configuration documentation](../../configuration/identity-providers/open-id-connect.md) for information on how
to configure [OpenID Connect]. to configure the Authelia [OpenID Connect 1.0] Provider.
## Scope Definitions ## Scope Definitions
### openid ### openid
This is the default scope for [OpenID Connect]. This field is forced on every client by the configuration validation This is the default scope for [OpenID Connect 1.0]. This field is forced on every client by the configuration validation
that Authelia does. that Authelia does.
*__Important Note:__ The subject identifiers or `sub` [Claim] has been changed to a [RFC4122] UUID V4 to identify the *__Important Note:__ The subject identifiers or `sub` [Claim] has been changed to a [RFC4122] UUID V4 to identify the
individual user as per the [Subject Identifier Types] section of the [OpenID Connect] specification. Please use the individual user as per the [Subject Identifier Types] section of the [OpenID Connect 1.0] specification. Please use the
`preferred_username` [Claim] instead.* `preferred_username` [Claim] instead.*
| [Claim] | JWT Type | Authelia Attribute | Description | | [Claim] | JWT Type | Authelia Attribute | Description |
@ -91,7 +92,7 @@ This scope includes the profile information the authentication backend reports a
Authelia currently supports adding the `amr` [Claim] to the [ID Token] utilizing the [RFC8176] Authentication Method Authelia currently supports adding the `amr` [Claim] to the [ID Token] utilizing the [RFC8176] Authentication Method
Reference values. Reference values.
The values this [Claim] has are not strictly defined by the [OpenID Connect] specification. As such, some backends may The values this [Claim] has are not strictly defined by the [OpenID Connect 1.0] specification. As such, some backends may
expect a specification other than [RFC8176] for this purpose. If you have such an application and wish for us to support expect a specification other than [RFC8176] for this purpose. If you have such an application and wish for us to support
it then you're encouraged to create a [feature request](https://www.authelia.com/l/fr). it then you're encouraged to create a [feature request](https://www.authelia.com/l/fr).
@ -162,7 +163,7 @@ These endpoints implement OpenID Connect elements.
[Claims]: https://openid.net/specs/openid-connect-core-1_0.html#Claims [Claims]: https://openid.net/specs/openid-connect-core-1_0.html#Claims
[Claim]: https://openid.net/specs/openid-connect-core-1_0.html#Claims [Claim]: https://openid.net/specs/openid-connect-core-1_0.html#Claims
[OpenID Connect]: https://openid.net/connect/ [OpenID Connect 1.0]: https://openid.net/connect/
[OpenID Connect Discovery]: https://openid.net/specs/openid-connect-discovery-1_0.html [OpenID Connect Discovery]: https://openid.net/specs/openid-connect-discovery-1_0.html
[OAuth 2.0 Authorization Server Metadata]: https://www.rfc-editor.org/rfc/rfc8414.html [OAuth 2.0 Authorization Server Metadata]: https://www.rfc-editor.org/rfc/rfc8414.html

4
docs/content/en/integration/openid-connect/komga/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Komga] to utilize Authelia as an [OpenID Connect] Provider: To configure [Komga] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Configure the security section of the [Komga] configuration: 1. Configure the security section of the [Komga] configuration:
```yaml ```yaml
@ -99,4 +99,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Komga]: https://www.komga.org [Komga]: https://www.komga.org
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/nextcloud/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Nextcloud] to utilize Authelia as an [OpenID Connect] Provider: To configure [Nextcloud] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Install the [Nextcloud OpenID Connect Login app] 1. Install the [Nextcloud OpenID Connect Login app]
2. Add the following to the [Nextcloud] `config.php` configuration: 2. Add the following to the [Nextcloud] `config.php` configuration:
@ -115,4 +115,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Nextcloud]: https://nextcloud.com/ [Nextcloud]: https://nextcloud.com/
[Nextcloud OpenID Connect Login app]: https://apps.nextcloud.com/apps/oidc_login [Nextcloud OpenID Connect Login app]: https://apps.nextcloud.com/apps/oidc_login
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/outline/index.md
View File

@ -47,7 +47,7 @@ in an error as [Outline] will attempt to use a refresh token that is never issue
### Application ### Application
To configure [Outline] to utilize Authelia as an [OpenID Connect] Provider: To configure [Outline] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Configure the following environment options: 1. Configure the following environment options:
```text ```text
@ -92,4 +92,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Outline]: https://www.getoutline.com/ [Outline]: https://www.getoutline.com/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/portainer/index.md
View File

@ -46,7 +46,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Portainer] to utilize Authelia as an [OpenID Connect] Provider: To configure [Portainer] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Visit Settings 1. Visit Settings
2. Visit Authentication 2. Visit Authentication
@ -93,4 +93,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Portainer]: https://www.portainer.io/ [Portainer]: https://www.portainer.io/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/proxmox/index.md
View File

@ -50,7 +50,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Proxmox] to utilize Authelia as an [OpenID Connect] Provider: To configure [Proxmox] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Visit Datacenter 1. Visit Datacenter
2. Visit Permission 2. Visit Permission
@ -94,4 +94,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Proxmox]: https://www.proxmox.com/ [Proxmox]: https://www.proxmox.com/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/seafile/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Seafile] to utilize Authelia as an [OpenID Connect] Provider: To configure [Seafile] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. [Seafile] may require some dependencies such as `requests_oauthlib` to be manually installed. 1. [Seafile] may require some dependencies such as `requests_oauthlib` to be manually installed.
See the [Seafile] documentation in the [see also](#see-also) section for more information. See the [Seafile] documentation in the [see also](#see-also) section for more information.
@ -100,4 +100,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Seafile]: https://www.seafile.com/ [Seafile]: https://www.seafile.com/
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

4
docs/content/en/integration/openid-connect/synapse/index.md
View File

@ -44,7 +44,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Synapse] to utilize Authelia as an [OpenID Connect] Provider: To configure [Synapse] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Edit your [Synapse] `homeserver.yaml` configuration file and add configure the following: 1. Edit your [Synapse] `homeserver.yaml` configuration file and add configure the following:
@ -94,4 +94,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Synapse]: https://github.com/matrix-org/synapse [Synapse]: https://github.com/matrix-org/synapse
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

6
docs/content/en/integration/openid-connect/synology-dsm/index.md
View File

@ -33,7 +33,7 @@ community: true
### Specific Notes ### Specific Notes
*__Important Note:__ [Synology DSM] does not support automatically creating users via [OpenID Connect]. It is therefore *__Important Note:__ [Synology DSM] does not support automatically creating users via [OpenID Connect 1.0]. It is therefore
recommended that you ensure Authelia and [Synology DSM] share a LDAP server.* recommended that you ensure Authelia and [Synology DSM] share a LDAP server.*
### Assumptions ### Assumptions
@ -49,7 +49,7 @@ This example makes the following assumptions:
### Application ### Application
To configure [Synology DSM] to utilize Authelia as an [OpenID Connect] Provider: To configure [Synology DSM] to utilize Authelia as an [OpenID Connect 1.0] Provider:
1. Go to DSM. 1. Go to DSM.
2. Go to `Control Panel`. 2. Go to `Control Panel`.
@ -97,4 +97,4 @@ which will operate with the above example:
[Authelia]: https://www.authelia.com [Authelia]: https://www.authelia.com
[Synology DSM]: https://www.synology.com/en-global/dsm [Synology DSM]: https://www.synology.com/en-global/dsm
[OpenID Connect]: ../../openid-connect/introduction.md [OpenID Connect 1.0]: ../../openid-connect/introduction.md

5
docs/content/en/integration/proxies/traefik.md
View File

@ -364,7 +364,10 @@ http:
middlewares: middlewares:
authelia: authelia:
forwardAuth: forwardAuth:
address: 'https://authelia:9091/api/authz/forward-auth?authelia_url=https%3A%2F%2Fauth.example.com%2F' address: 'http://authelia:9091/api/authz/forward-auth'
## The following commented line is for configuring the Authelia URL in the proxy. We strongly suggest this is
## configured in the Session Cookies section of the Authelia configuration.
# address: 'https://authelia:9091/api/authz/forward-auth?authelia_url=https%3A%2F%2Fauth.example.com%2F'
trustForwardHeader: true trustForwardHeader: true
authResponseHeaders: authResponseHeaders:
- 'Authorization' - 'Authorization'

6
docs/content/en/reference/cli/authelia-gen/authelia-gen.md
View File

@ -30,9 +30,10 @@ authelia-gen [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -41,7 +42,8 @@ authelia-gen [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
-h, --help help for authelia-gen -h, --help help for authelia-gen
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_code.md
View File

@ -36,9 +36,10 @@ authelia-gen code [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen code [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_code_keys.md
View File

@ -36,9 +36,10 @@ authelia-gen code keys [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen code keys [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_code_scripts.md
View File

@ -36,9 +36,10 @@ authelia-gen code scripts [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen code scripts [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_code_server.md
View File

@ -36,9 +36,10 @@ authelia-gen code server [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen code server [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_commit-lint.md
View File

@ -36,9 +36,10 @@ authelia-gen commit-lint [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen commit-lint [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_docs.md
View File

@ -36,9 +36,10 @@ authelia-gen docs [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen docs [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_cli.md
View File

@ -36,9 +36,10 @@ authelia-gen docs cli [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen docs cli [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_data.md
View File

@ -36,9 +36,10 @@ authelia-gen docs data [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen docs data [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_data_keys.md
View File

@ -36,9 +36,10 @@ authelia-gen docs data keys [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen docs data keys [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_data_misc.md
View File

@ -36,9 +36,10 @@ authelia-gen docs data misc [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen docs data misc [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_date.md
View File

@ -38,9 +38,10 @@ authelia-gen docs date [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -49,7 +50,8 @@ authelia-gen docs date [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_github.md
View File

@ -36,9 +36,10 @@ authelia-gen github [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen github [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_github_issue-templates.md
View File

@ -36,9 +36,10 @@ authelia-gen github issue-templates [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen github issue-templates [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_github_issue-templates_bug-report.md
View File

@ -36,9 +36,10 @@ authelia-gen github issue-templates bug-report [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen github issue-templates bug-report [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_github_issue-templates_feature-request.md
View File

@ -36,9 +36,10 @@ authelia-gen github issue-templates feature-request [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen github issue-templates feature-request [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

6
docs/content/en/reference/cli/authelia-gen/authelia-gen_locales.md
View File

@ -36,9 +36,10 @@ authelia-gen locales [flags]
--dir.docs.data string The directory with the docs data (default "data") --dir.docs.data string The directory with the docs data (default "data")
--dir.locales string The locales directory in relation to the root (default "internal/server/locales") --dir.locales string The locales directory in relation to the root (default "internal/server/locales")
-d, --dir.root string The repository root (default "./") -d, --dir.root string The repository root (default "./")
--dir.web string The repository web directory in relation to the root directory (default "web")
-X, --exclude strings Sets the names of excluded generators -X, --exclude strings Sets the names of excluded generators
--file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml") --file.bug-report string Sets the path of the bug report issue template file (default ".github/ISSUE_TEMPLATE/bug-report.yml")
--file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default "web/.commitlintrc.js") --file.commit-lint-config string The commit lint javascript configuration file in relation to the root (default ".commitlintrc.js")
--file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go") --file.configuration-keys string Sets the path of the keys file (default "internal/configuration/schema/keys.go")
--file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md") --file.docs-commit-msg-guidelines string The commit message guidelines documentation file in relation to the root (default "docs/content/en/contributing/guidelines/commit-message.md")
--file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json") --file.docs.data.keys string Sets the path of the docs keys file (default "configkeys.json")
@ -47,7 +48,8 @@ authelia-gen locales [flags]
--file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml") --file.feature-request string Sets the path of the feature request issue template file (default ".github/ISSUE_TEMPLATE/feature-request.yml")
--file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go") --file.scripts.gen string Sets the path of the authelia-scripts gen file (default "cmd/authelia-scripts/cmd/gen.go")
--file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go") --file.server.generated string Sets the path of the server generated file (default "internal/server/gen.go")
--file.web-i18n string The i18n typescript configuration file in relation to the root (default "web/src/i18n/index.ts") --file.web.i18n string The i18n typescript configuration file in relation to the web directory (default "src/i18n/index.ts")
--file.web.package string The node package configuration file in relation to the web directory (default "package.json")
--package.configuration.keys string Sets the package name of the keys file (default "schema") --package.configuration.keys string Sets the package name of the keys file (default "schema")
--package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd") --package.scripts.gen string Sets the package name of the authelia-scripts gen file (default "cmd")
--versions int the maximum number of minor versions to list in output templates (default 5) --versions int the maximum number of minor versions to list in output templates (default 5)

2
docs/content/en/reference/guides/proxy-authorization.md
View File

@ -2,7 +2,7 @@
title: "Proxy Authorization" title: "Proxy Authorization"
description: "A reference guide on Proxy Authorization implementations" description: "A reference guide on Proxy Authorization implementations"
lead: "This section contains reference guide on Proxy Authorization implementations Authelia supports." lead: "This section contains reference guide on Proxy Authorization implementations Authelia supports."
date: 2022-10-31T09:33:39+11:00 date: 2023-01-25T20:36:40+11:00
draft: false draft: false
images: [] images: []
menu: menu:

2
docs/data/configkeys.json
View File

File diff suppressed because one or more lines are too long

2
docs/data/misc.json
View File

@ -1 +1 @@
{"csp":{"default":"default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-${NONCE}'; frame-ancestors 'none'; base-uri 'self'","development":"default-src 'self' 'unsafe-eval'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-${NONCE}'; frame-ancestors 'none'; base-uri 'self'","nonce":"${NONCE}"}} {"csp":{"default":"default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-${NONCE}'; frame-ancestors 'none'; base-uri 'self'","development":"default-src 'self' 'unsafe-eval'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-${NONCE}'; frame-ancestors 'none'; base-uri 'self'","nonce":"${NONCE}"},"latest":"4.37.5"}

2
docs/layouts/index.html
View File

@ -7,7 +7,7 @@
<div class="col-lg-9 col-xl-8 text-center"> <div class="col-lg-9 col-xl-8 text-center">
<p class="lead">{{ .Params.lead | safeHTML }}</p> <p class="lead">{{ .Params.lead | safeHTML }}</p>
<a class="btn btn-primary btn-lg px-4 mb-2" href="/integration/prologue/get-started/" role="button">Get Started</a> <a class="btn btn-primary btn-lg px-4 mb-2" href="/integration/prologue/get-started/" role="button">Get Started</a>
<p class="meta">Open-source Apache 2.0 Licensed. <a href="https://github.com/authelia/authelia">GitHub v{{ $data := getJSON "https://raw.githubusercontent.com/authelia/authelia/master/web/package.json" }}{{ $data.version }}</a></p> <p class="meta">Open-source Apache 2.0 Licensed. <a href="https://github.com/authelia/authelia">GitHub v{{ $.Site.Data.misc.latest }}</a></p>
</div> </div>
</div> </div>
</section> </section>

8
web/package.json
View File

@ -28,7 +28,7 @@
"@mui/icons-material": "5.11.0", "@mui/icons-material": "5.11.0",
"@mui/material": "5.11.6", "@mui/material": "5.11.6",
"@mui/styles": "5.11.2", "@mui/styles": "5.11.2",
"axios": "1.2.4", "axios": "1.2.5",
"broadcast-channel": "4.20.2", "broadcast-channel": "4.20.2",
"classnames": "2.3.2", "classnames": "2.3.2",
"i18next": "22.4.9", "i18next": "22.4.9",
@ -39,7 +39,7 @@
"react-dom": "18.2.0", "react-dom": "18.2.0",
"react-i18next": "12.1.4", "react-i18next": "12.1.4",
"react-loading": "2.0.3", "react-loading": "2.0.3",
"react-router-dom": "6.7.0", "react-router-dom": "6.8.0",
"react18-input-otp": "1.1.2", "react18-input-otp": "1.1.2",
"zxcvbn": "4.4.2" "zxcvbn": "4.4.2"
}, },
@ -169,8 +169,8 @@
"eslint-plugin-react": "7.32.1", "eslint-plugin-react": "7.32.1",
"eslint-plugin-react-hooks": "4.6.0", "eslint-plugin-react-hooks": "4.6.0",
"husky": "8.0.3", "husky": "8.0.3",
"jest": "29.4.0", "jest": "29.4.1",
"jest-environment-jsdom": "29.4.0", "jest-environment-jsdom": "29.4.1",
"jest-transform-stub": "2.0.0", "jest-transform-stub": "2.0.0",
"jest-watch-typeahead": "2.2.2", "jest-watch-typeahead": "2.2.2",
"prettier": "2.8.3", "prettier": "2.8.3",

536
web/pnpm-lock.yaml
View File

File diff suppressed because it is too large Load Diff