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

docs: remove cobra auto gen tags (#3937)

pull/3938/head^2
James Elliott 2022-09-01 12:24:47 +10:00 committed by GitHub
parent 426ac3c3af
commit f17268ee80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
99 changed files with 131 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -9,6 +9,8 @@ func newAllCmd() *cobra.Command {
Use: "all",
Short: "Run all generators with default options",
RunE: allRunE,
DisableAutoGenTag: true,
}
return cmd

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

@ -9,6 +9,8 @@ func newCodeCmd() *cobra.Command {
Use: "code",
Short: "Generate code",
RunE: codeRunE,
DisableAutoGenTag: true,
}
cmd.AddCommand(newCodeKeysCmd())

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

@ -21,6 +21,8 @@ func newCodeKeysCmd() *cobra.Command {
Use: "keys",
Short: "Generate the list of valid configuration keys",
RunE: codeKeysRunE,
DisableAutoGenTag: true,
}
cmd.Flags().StringP("file", "f", "./internal/configuration/schema/keys.go", "Sets the path of the keys file")

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

@ -9,6 +9,8 @@ func newDocsCmd() *cobra.Command {
Use: "docs",
Short: "Generate docs",
RunE: docsRunE,
DisableAutoGenTag: true,
}
cmd.PersistentFlags().StringP("cwd", "C", "", "Sets the CWD for git commands")

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

@ -19,6 +19,8 @@ func newDocsCLICmd() *cobra.Command {
Use: "cli",
Short: "Generate CLI docs",
RunE: docsCLIRunE,
DisableAutoGenTag: true,
}
cmd.Flags().StringP("directory", "d", "./docs/content/en/reference/cli", "The directory to store the markdown in")

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

@ -20,6 +20,8 @@ func newDocsDateCmd() *cobra.Command {
Use: "date",
Short: "Generate doc dates",
RunE: docsDateRunE,
DisableAutoGenTag: true,
}
cmd.Flags().StringP("directory", "d", "./docs/content", "The directory to modify")

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

@ -19,6 +19,8 @@ func newRootCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "authelia-gen",
Short: "Authelia's generator tooling",
DisableAutoGenTag: true,
}
cmd.AddCommand(newAllCmd(), newCodeCmd(), newDocsCmd())

2
cmd/authelia-scripts/cmd/bootstrap.go
View File

@ -20,6 +20,8 @@ func newBootstrapCmd() (cmd *cobra.Command) {
Example: cmdBootstrapExample,
Args: cobra.NoArgs,
Run: cmdBootstrapRun,
DisableAutoGenTag: true,
}
return cmd

2
cmd/authelia-scripts/cmd/build.go
View File

@ -20,6 +20,8 @@ func newBuildCmd() (cmd *cobra.Command) {
Example: cmdBuildExample,
Args: cobra.NoArgs,
Run: cmdBuildRun,
DisableAutoGenTag: true,
}
return cmd

2
cmd/authelia-scripts/cmd/ci.go
View File

@ -15,6 +15,8 @@ func newCICmd() (cmd *cobra.Command) {
Example: cmdCIExample,
Args: cobra.NoArgs,
Run: cmdCIRun,
DisableAutoGenTag: true,
}
return cmd

2
cmd/authelia-scripts/cmd/clean.go
View File

@ -15,6 +15,8 @@ func newCleanCmd() (cmd *cobra.Command) {
Example: cmdCleanExample,
Args: cobra.NoArgs,
Run: cmdCleanRun,
DisableAutoGenTag: true,
}
return cmd

6
cmd/authelia-scripts/cmd/docker.go
View File

@ -31,6 +31,8 @@ func newDockerCmd() (cmd *cobra.Command) {
Example: cmdDockerExample,
Args: cobra.NoArgs,
Run: cmdDockerBuildRun,
DisableAutoGenTag: true,
}
cmd.AddCommand(newDockerBuildCmd(), newDockerPushManifestCmd())
@ -46,6 +48,8 @@ func newDockerBuildCmd() (cmd *cobra.Command) {
Example: cmdDockerBuildExample,
Args: cobra.NoArgs,
Run: cmdDockerBuildRun,
DisableAutoGenTag: true,
}
cmd.PersistentFlags().StringVar(&container, "container", defaultContainer, "target container among: "+strings.Join(containers, ", "))
@ -61,6 +65,8 @@ func newDockerPushManifestCmd() (cmd *cobra.Command) {
Example: cmdDockerPushManifestExample,
Args: cobra.NoArgs,
Run: cmdDockerPushManifestRun,
DisableAutoGenTag: true,
}
return cmd

2
cmd/authelia-scripts/cmd/root.go
View File

@ -12,6 +12,8 @@ func NewRootCmd() (cmd *cobra.Command) {
Short: cmdRootShort,
Long: cmdRootLong,
Example: cmdRootExample,
DisableAutoGenTag: true,
}
cmd.PersistentFlags().Bool("buildkite", false, "Set CI flag for Buildkite")

2
cmd/authelia-scripts/cmd/serve.go
View File

@ -15,6 +15,8 @@ func newServeCmd() (cmd *cobra.Command) {
Example: cmdServeExample,
Args: cobra.MinimumNArgs(1),
Run: cmdServeRun,
DisableAutoGenTag: true,
}
return cmd

10
cmd/authelia-scripts/cmd/suites.go
View File

@ -31,6 +31,8 @@ func newSuitesCmd() (cmd *cobra.Command) {
Example: cmdSuitesExample,
Run: cmdSuitesListRun,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
cmd.AddCommand(newSuitesListCmd(), newSuitesSetupCmd(), newSuitesTestCmd(), newSuitesTeardownCmd())
@ -46,6 +48,8 @@ func newSuitesListCmd() (cmd *cobra.Command) {
Example: cmdSuitesListExample,
Run: cmdSuitesListRun,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
return cmd
@ -59,6 +63,8 @@ func newSuitesSetupCmd() (cmd *cobra.Command) {
Example: cmdSuitesSetupExample,
Run: cmdSuitesSetupRun,
Args: cobra.MaximumNArgs(1),
DisableAutoGenTag: true,
}
return cmd
@ -72,6 +78,8 @@ func newSuitesTeardownCmd() (cmd *cobra.Command) {
Example: cmdSuitesTeardownExample,
Run: cmdSuitesTeardownRun,
Args: cobra.MaximumNArgs(1),
DisableAutoGenTag: true,
}
return cmd
@ -85,6 +93,8 @@ func newSuitesTestCmd() (cmd *cobra.Command) {
Example: cmdSuitesTestExample,
Run: cmdSuitesTestRun,
Args: cobra.MaximumNArgs(1),
DisableAutoGenTag: true,
}
cmd.Flags().BoolVar(&failfast, "failfast", false, "Stops tests on first failure")

2
cmd/authelia-scripts/cmd/unittest.go
View File

@ -17,6 +17,8 @@ func newUnitTestCmd() (cmd *cobra.Command) {
Example: cmdUnitTestExample,
Args: cobra.NoArgs,
Run: cmdUnitTestRun,
DisableAutoGenTag: true,
}
return cmd

2
cmd/authelia-scripts/cmd/xflags.go
View File

@ -16,6 +16,8 @@ func newXFlagsCmd() (cmd *cobra.Command) {
Example: cmdXFlagsExample,
Args: cobra.NoArgs,
Run: cmdXFlagsRun,
DisableAutoGenTag: true,
}
cmd.Flags().StringP("build", "b", "0", "Sets the BuildNumber flag value")

10
cmd/authelia-suites/main.go
View File

@ -26,30 +26,40 @@ func init() {
func main() {
rootCmd := &cobra.Command{
Use: "authelia-suites",
DisableAutoGenTag: true,
}
startCmd := &cobra.Command{
Use: "setup [suite]",
Short: "Setup the suite environment",
Run: setupSuite,
DisableAutoGenTag: true,
}
setupTimeoutCmd := &cobra.Command{
Use: "timeout [suite]",
Short: "Run the OnSetupTimeout callback when setup times out",
Run: setupTimeoutSuite,
DisableAutoGenTag: true,
}
errorCmd := &cobra.Command{
Use: "error [suite]",
Short: "Run the OnError callback when some tests fail",
Run: runErrorCallback,
DisableAutoGenTag: true,
}
stopCmd := &cobra.Command{
Use: "teardown [suite]",
Short: "Teardown the suite environment",
Run: teardownSuite,
DisableAutoGenTag: true,
}
rootCmd.AddCommand(startCmd)

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

@ -2,7 +2,7 @@
title: "Apache Guacamole"
description: "Integrating Apache Guacamole with the Authelia OpenID Connect Provider."
lead: ""
date: 2022-07-13T03:42:47+10:00
date: 2022-07-31T13:09:05+10:00
draft: false
images: []
menu:

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

@ -2,7 +2,7 @@
title: "Argo CD"
description: "Integrating Argo CD with the Authelia OpenID Connect Provider."
lead: ""
date: 2022-07-13T03:42:47+10:00
date: 2022-07-13T04:27:30+10:00
draft: false
images: []
menu:

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

@ -2,7 +2,7 @@
title: "Komga"
description: "Integrating Komga with the Authelia OpenID Connect Provider."
lead: ""
date: 2022-06-15T17:51:47+10:00
date: 2022-08-26T11:39:00+10:00
draft: false
images: []
menu:

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

@ -2,7 +2,7 @@
title: "Outline"
description: "Integrating Outline with the Authelia OpenID Connect Provider."
lead: ""
date: 2022-06-15T17:51:47+10:00
date: 2022-08-12T09:11:42+10:00
draft: false
images: []
menu:

2
docs/content/en/integration/trusted-header-sso/seafile/index.md
View File

@ -2,7 +2,7 @@
title: "Seafile"
description: "Trusted Header SSO Integration for Seafile"
lead: ""
date: 2022-06-15T17:51:47+10:00
date: 2022-08-26T11:34:56+10:00
draft: false
images: []
menu:

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

@ -28,4 +28,3 @@ Authelia's generator tooling
* [authelia-gen code](authelia-gen_code.md) - Generate code
* [authelia-gen docs](authelia-gen_docs.md) - Generate docs
###### Auto generated by spf13/cobra on 27-Jun-2022

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

@ -30,4 +30,3 @@ authelia-gen all [flags]
* [authelia-gen](authelia-gen.md) - Authelia's generator tooling
###### Auto generated by spf13/cobra on 27-Jun-2022

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

@ -31,4 +31,3 @@ authelia-gen code [flags]
* [authelia-gen](authelia-gen.md) - Authelia's generator tooling
* [authelia-gen code keys](authelia-gen_code_keys.md) - Generate the list of valid configuration keys
###### Auto generated by spf13/cobra on 27-Jun-2022

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

@ -32,4 +32,3 @@ authelia-gen code keys [flags]
* [authelia-gen code](authelia-gen_code.md) - Generate code
###### Auto generated by spf13/cobra on 27-Jun-2022

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

@ -33,4 +33,3 @@ authelia-gen docs [flags]
* [authelia-gen docs cli](authelia-gen_docs_cli.md) - Generate CLI docs
* [authelia-gen docs date](authelia-gen_docs_date.md) - Generate doc dates
###### Auto generated by spf13/cobra on 27-Jun-2022

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

@ -37,4 +37,3 @@ authelia-gen docs cli [flags]
* [authelia-gen docs](authelia-gen_docs.md) - Generate docs
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts.md
View File

@ -49,4 +49,3 @@ authelia-scripts help
* [authelia-scripts unittest](authelia-scripts_unittest.md) - Run unit tests
* [authelia-scripts xflags](authelia-scripts_xflags.md) - Generate X LDFlags for building Authelia
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_bootstrap.md
View File

@ -47,4 +47,3 @@ authelia-scripts bootstrap
* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process.
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_build.md
View File

@ -47,4 +47,3 @@ authelia-scripts build
* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process.
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_ci.md
View File

@ -47,4 +47,3 @@ authelia-scripts ci
* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process.
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_clean.md
View File

@ -47,4 +47,3 @@ authelia-scripts clean
* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process.
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker.md
View File

@ -49,4 +49,3 @@ authelia-scripts docker
* [authelia-scripts docker build](authelia-scripts_docker_build.md) - Build the docker image of Authelia
* [authelia-scripts docker push-manifest](authelia-scripts_docker_push-manifest.md) - Push Authelia docker manifest to the Docker registries
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_build.md
View File

@ -48,4 +48,3 @@ authelia-scripts docker build
* [authelia-scripts docker](authelia-scripts_docker.md) - Commands related to building and publishing docker image
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_push-manifest.md
View File

@ -47,4 +47,3 @@ authelia-scripts docker push-manifest
* [authelia-scripts docker](authelia-scripts_docker.md) - Commands related to building and publishing docker image
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_serve.md
View File

@ -47,4 +47,3 @@ authelia-scripts serve test.yml
* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process.
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites.md
View File

@ -51,4 +51,3 @@ authelia-scripts suites
* [authelia-scripts suites teardown](authelia-scripts_suites_teardown.md) - Teardown a test suite environment
* [authelia-scripts suites test](authelia-scripts_suites_test.md) - Run a test suite
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_list.md
View File

@ -49,4 +49,3 @@ authelia-scripts suites list
* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_setup.md
View File

@ -49,4 +49,3 @@ authelia-scripts suites setup Standalone
* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_teardown.md
View File

@ -49,4 +49,3 @@ authelia-scripts suites setup Standalone
* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_test.md
View File

@ -52,4 +52,3 @@ authelia-scripts suites test Standalone
* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_unittest.md
View File

@ -47,4 +47,3 @@ authelia-scripts unittest
* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process.
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia-scripts/authelia-scripts_xflags.md
View File

@ -49,4 +49,3 @@ authelia-scripts xflags
* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process.
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia.md
View File

@ -54,4 +54,3 @@ authelia --config /etc/authelia/config/
* [authelia storage](authelia_storage.md) - Manage the Authelia storage
* [authelia validate-config](authelia_validate-config.md) - Check a configuration against the internal configuration validation mechanisms
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_access-control.md
View File

@ -37,4 +37,3 @@ authelia access-control --help
* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown)
* [authelia access-control check-policy](authelia_access-control_check-policy.md) - Checks a request against the access control rules to determine what policy would be applied
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_access-control_check-policy.md
View File

@ -67,4 +67,3 @@ authelia access-control check-policy --config config.yml --url https://example.c
* [authelia access-control](authelia_access-control.md) - Helpers for the access control system
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_build-info.md
View File

@ -49,4 +49,3 @@ authelia build-info
* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown)
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto.md
View File

@ -40,4 +40,3 @@ authelia crypto --help
* [authelia crypto certificate](authelia_crypto_certificate.md) - Perform certificate cryptographic operations
* [authelia crypto pair](authelia_crypto_pair.md) - Perform key pair cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate.md
View File

@ -41,4 +41,3 @@ authelia crypto certificate --help
* [authelia crypto certificate ed25519](authelia_crypto_certificate_ed25519.md) - Perform Ed25519 certificate cryptographic operations
* [authelia crypto certificate rsa](authelia_crypto_certificate_rsa.md) - Perform RSA certificate cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_ecdsa.md
View File

@ -40,4 +40,3 @@ authelia crypto certificate ecdsa --help
* [authelia crypto certificate ecdsa generate](authelia_crypto_certificate_ecdsa_generate.md) - Generate an ECDSA private key and certificate
* [authelia crypto certificate ecdsa request](authelia_crypto_certificate_ecdsa_request.md) - Generate an ECDSA private key and certificate signing request
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_ecdsa_generate.md
View File

@ -63,4 +63,3 @@ authelia crypto certificate ecdsa generate --help
* [authelia crypto certificate ecdsa](authelia_crypto_certificate_ecdsa.md) - Perform ECDSA certificate cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_ecdsa_request.md
View File

@ -58,4 +58,3 @@ authelia crypto certificate ecdsa request --help
* [authelia crypto certificate ecdsa](authelia_crypto_certificate_ecdsa.md) - Perform ECDSA certificate cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_ed25519.md
View File

@ -40,4 +40,3 @@ authelia crypto certificate ed25519 --help
* [authelia crypto certificate ed25519 generate](authelia_crypto_certificate_ed25519_generate.md) - Generate an Ed25519 private key and certificate
* [authelia crypto certificate ed25519 request](authelia_crypto_certificate_ed25519_request.md) - Generate an Ed25519 private key and certificate signing request
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_ed25519_generate.md
View File

@ -62,4 +62,3 @@ authelia crypto certificate ed25519 request --help
* [authelia crypto certificate ed25519](authelia_crypto_certificate_ed25519.md) - Perform Ed25519 certificate cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_ed25519_request.md
View File

@ -57,4 +57,3 @@ authelia crypto certificate ed25519 request --help
* [authelia crypto certificate ed25519](authelia_crypto_certificate_ed25519.md) - Perform Ed25519 certificate cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_rsa.md
View File

@ -40,4 +40,3 @@ authelia crypto certificate rsa --help
* [authelia crypto certificate rsa generate](authelia_crypto_certificate_rsa_generate.md) - Generate an RSA private key and certificate
* [authelia crypto certificate rsa request](authelia_crypto_certificate_rsa_request.md) - Generate an RSA private key and certificate signing request
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_rsa_generate.md
View File

@ -63,4 +63,3 @@ authelia crypto certificate rsa generate --help
* [authelia crypto certificate rsa](authelia_crypto_certificate_rsa.md) - Perform RSA certificate cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_certificate_rsa_request.md
View File

@ -58,4 +58,3 @@ authelia crypto certificate rsa request --help
* [authelia crypto certificate rsa](authelia_crypto_certificate_rsa.md) - Perform RSA certificate cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_pair.md
View File

@ -41,4 +41,3 @@ authelia crypto pair --help
* [authelia crypto pair ed25519](authelia_crypto_pair_ed25519.md) - Perform Ed25519 key pair cryptographic operations
* [authelia crypto pair rsa](authelia_crypto_pair_rsa.md) - Perform RSA key pair cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_pair_ecdsa.md
View File

@ -43,4 +43,3 @@ authelia crypto pair ecdsa --help
* [authelia crypto pair](authelia_crypto_pair.md) - Perform key pair cryptographic operations
* [authelia crypto pair ecdsa generate](authelia_crypto_pair_ecdsa_generate.md) - Generate a cryptographic ECDSA key pair
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_pair_ecdsa_generate.md
View File

@ -47,4 +47,3 @@ authelia crypto pair ecdsa generate --help
* [authelia crypto pair ecdsa](authelia_crypto_pair_ecdsa.md) - Perform ECDSA key pair cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_pair_ed25519.md
View File

@ -43,4 +43,3 @@ authelia crypto pair ed25519 --help
* [authelia crypto pair](authelia_crypto_pair.md) - Perform key pair cryptographic operations
* [authelia crypto pair ed25519 generate](authelia_crypto_pair_ed25519_generate.md) - Generate a cryptographic Ed25519 key pair
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_pair_ed25519_generate.md
View File

@ -46,4 +46,3 @@ authelia crypto pair ed25519 generate --help
* [authelia crypto pair ed25519](authelia_crypto_pair_ed25519.md) - Perform Ed25519 key pair cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_pair_rsa.md
View File

@ -43,4 +43,3 @@ authelia crypto pair rsa --help
* [authelia crypto pair](authelia_crypto_pair.md) - Perform key pair cryptographic operations
* [authelia crypto pair rsa generate](authelia_crypto_pair_rsa_generate.md) - Generate a cryptographic RSA key pair
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_crypto_pair_rsa_generate.md
View File

@ -47,4 +47,3 @@ authelia crypto pair rsa generate --help
* [authelia crypto pair rsa](authelia_crypto_pair_rsa.md) - Perform RSA key pair cryptographic operations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_hash-password.md
View File

@ -53,4 +53,3 @@ authelia hash-password --key-length=64 -- 'mypass'
* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown)
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage.md
View File

@ -62,4 +62,3 @@ authelia storage --help
* [authelia storage schema-info](authelia_storage_schema-info.md) - Show the storage information
* [authelia storage user](authelia_storage_user.md) - Manages user settings
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_encryption.md
View File

@ -63,4 +63,3 @@ authelia storage encryption --help
* [authelia storage encryption change-key](authelia_storage_encryption_change-key.md) - Changes the encryption key
* [authelia storage encryption check](authelia_storage_encryption_check.md) - Checks the encryption key against the database data
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_encryption_change-key.md
View File

@ -67,4 +67,3 @@ authelia storage encryption change-key --encryption-key b3453fde-ecc2-4a1f-9422-
* [authelia storage encryption](authelia_storage_encryption.md) - Manage storage encryption
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_encryption_check.md
View File

@ -69,4 +69,3 @@ authelia storage encryption check --verbose --encryption-key b3453fde-ecc2-4a1f-
* [authelia storage encryption](authelia_storage_encryption.md) - Manage storage encryption
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_migrate.md
View File

@ -66,4 +66,3 @@ authelia storage migrate --help
* [authelia storage migrate list-up](authelia_storage_migrate_list-up.md) - List the up migrations available
* [authelia storage migrate up](authelia_storage_migrate_up.md) - Perform a migration up
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_migrate_down.md
View File

@ -71,4 +71,3 @@ authelia storage migrate down --target 20 --encryption-key b3453fde-ecc2-4a1f-94
* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_migrate_history.md
View File

@ -67,4 +67,3 @@ authelia storage migrate history --encryption-key b3453fde-ecc2-4a1f-9422-2707dd
* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-down.md
View File

@ -68,4 +68,3 @@ authelia storage migrate list-down --encryption-key b3453fde-ecc2-4a1f-9422-2707
* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-up.md
View File

@ -68,4 +68,3 @@ authelia storage migrate list-up --encryption-key b3453fde-ecc2-4a1f-9422-2707dd
* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_migrate_up.md
View File

@ -70,4 +70,3 @@ authelia storage migrate up --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed49
* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_schema-info.md
View File

@ -67,4 +67,3 @@ authelia storage schema-info --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed4
* [authelia storage](authelia_storage.md) - Manage the Authelia storage
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user.md
View File

@ -63,4 +63,3 @@ authelia storage user --help
* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers
* [authelia storage user totp](authelia_storage_user_totp.md) - Manage TOTP configurations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers.md
View File

@ -65,4 +65,3 @@ authelia storage user identifiers --help
* [authelia storage user identifiers generate](authelia_storage_user_identifiers_generate.md) - Generate opaque identifiers in bulk
* [authelia storage user identifiers import](authelia_storage_user_identifiers_import.md) - Import the identifiers from a YAML file
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_add.md
View File

@ -70,4 +70,3 @@ authelia storage user identifiers add john --identifier f0919359-9d15-4e15-bcba-
* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_export.md
View File

@ -69,4 +69,3 @@ authelia storage user identifiers export --file export.yaml --encryption-key b34
* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_generate.md
View File

@ -72,4 +72,3 @@ authelia storage user identifiers generate --users john,mary --services openid -
* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_import.md
View File

@ -72,4 +72,3 @@ authelia storage user identifiers import --file export.yaml --encryption-key b34
* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_totp.md
View File

@ -64,4 +64,3 @@ authelia storage user totp --help
* [authelia storage user totp export](authelia_storage_user_totp_export.md) - Perform exports of the TOTP configurations
* [authelia storage user totp generate](authelia_storage_user_totp_generate.md) - Generate a TOTP configuration for a user
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_totp_delete.md
View File

@ -67,4 +67,3 @@ authelia storage user totp delete john --encryption-key b3453fde-ecc2-4a1f-9422-
* [authelia storage user totp](authelia_storage_user_totp.md) - Manage TOTP configurations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_totp_export.md
View File

@ -70,4 +70,3 @@ authelia storage user totp export --format png --dir ./totp-qr --encryption-key
* [authelia storage user totp](authelia_storage_user_totp.md) - Manage TOTP configurations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md
View File

@ -79,4 +79,3 @@ authelia storage user totp generate john --algorithm SHA512 --config config.yml
* [authelia storage user totp](authelia_storage_user_totp.md) - Manage TOTP configurations
###### Auto generated by spf13/cobra on 27-Jun-2022

1
docs/content/en/reference/cli/authelia/authelia_validate-config.md
View File

@ -45,4 +45,3 @@ authelia validate-config --config config.yml
* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown)
###### Auto generated by spf13/cobra on 27-Jun-2022

2
docs/content/en/reference/guides/domain-sanitizaiton.md
View File

@ -2,7 +2,7 @@
title: "Domain Sanitization"
description: "This guide describes and helps users sanitize provided files to hide their domain"
lead: "This guide describes and helps users sanitize provided files to hide their domain."
date: 2022-06-20T10:05:55+10:00
date: 2022-08-26T13:50:51+10:00
draft: false
images: []
menu:

2
docs/content/en/reference/guides/http-archive-file.md
View File

@ -2,7 +2,7 @@
title: "HTTP Archive Files"
description: "This guide describes and helps users create HTTP Archive (HAR) files"
lead: "This guide describes and helps users create HTTP Archive (HAR) files."
date: 2022-06-20T10:05:55+10:00
date: 2022-08-26T13:50:51+10:00
draft: false
images: []
menu:

4
internal/commands/acl.go
View File

@ -21,6 +21,8 @@ func newAccessControlCommand() (cmd *cobra.Command) {
Short: cmdAutheliaAccessControlShort,
Long: cmdAutheliaAccessControlLong,
Example: cmdAutheliaAccessControlExample,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -37,6 +39,8 @@ func newAccessControlCheckCommand() (cmd *cobra.Command) {
Long: cmdAutheliaAccessControlCheckPolicyLong,
Example: cmdAutheliaAccessControlCheckPolicyExample,
RunE: accessControlCheckRunE,
DisableAutoGenTag: true,
}
cmdWithConfigFlags(cmd, false, []string{"configuration.yml"})

2
internal/commands/build-info.go
View File

@ -17,6 +17,8 @@ func newBuildInfoCmd() (cmd *cobra.Command) {
Example: cmdAutheliaBuildInfoExample,
RunE: cmdBuildInfoRunE,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
return cmd

14
internal/commands/crypto.go
View File

@ -22,6 +22,8 @@ func newCryptoCmd() (cmd *cobra.Command) {
Long: cmdAutheliaCryptoLong,
Example: cmdAutheliaCryptoExample,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -39,6 +41,8 @@ func newCryptoCertificateCmd() (cmd *cobra.Command) {
Long: cmdAutheliaCryptoCertificateLong,
Example: cmdAutheliaCryptoCertificateExample,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -72,6 +76,8 @@ func newCryptoCertificateSubCmd(use string) (cmd *cobra.Command) {
Long: fmt.Sprintf(fmtCmdAutheliaCryptoCertificateSubLong, useFmt, useFmt),
Example: example,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
cmd.AddCommand(newCryptoGenerateCmd(cmdUseCertificate, use), newCryptoCertificateRequestCmd(use))
@ -84,6 +90,8 @@ func newCryptoCertificateRequestCmd(algorithm string) (cmd *cobra.Command) {
Use: cmdUseRequest,
Args: cobra.NoArgs,
RunE: cryptoCertificateRequestRunE,
DisableAutoGenTag: true,
}
cmdFlagsCryptoPrivateKey(cmd)
@ -120,6 +128,8 @@ func newCryptoPairCmd() (cmd *cobra.Command) {
Long: cmdAutheliaCryptoPairLong,
Example: cmdAutheliaCryptoPairExample,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -154,6 +164,8 @@ func newCryptoPairSubCmd(use string) (cmd *cobra.Command) {
Example: example,
Args: cobra.NoArgs,
RunE: cryptoGenerateRunE,
DisableAutoGenTag: true,
}
cmd.AddCommand(newCryptoGenerateCmd(cmdUsePair, use))
@ -166,6 +178,8 @@ func newCryptoGenerateCmd(category, algorithm string) (cmd *cobra.Command) {
Use: cmdUseGenerate,
Args: cobra.NoArgs,
RunE: cryptoGenerateRunE,
DisableAutoGenTag: true,
}
cmdFlagsCryptoPrivateKey(cmd)

2
internal/commands/hash.go
View File

@ -20,6 +20,8 @@ func newHashPasswordCmd() (cmd *cobra.Command) {
Example: cmdAutheliaHashPasswordExample,
Args: cobra.MinimumNArgs(1),
RunE: cmdHashPasswordRunE,
DisableAutoGenTag: true,
}
cmd.Flags().BoolP("sha512", "z", false, fmt.Sprintf("use sha512 as the algorithm (changes iterations to %d, change with -i)", schema.DefaultPasswordSHA512Configuration.Iterations))

2
internal/commands/root.go
View File

@ -35,6 +35,8 @@ func NewRootCmd() (cmd *cobra.Command) {
Args: cobra.NoArgs,
PreRun: newCmdWithConfigPreRun(true, true, true),
Run: cmdRootRun,
DisableAutoGenTag: true,
}
cmdWithConfigFlags(cmd, false, []string{})

42
internal/commands/storage.go
View File

@ -17,6 +17,8 @@ func newStorageCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageExample,
Args: cobra.NoArgs,
PersistentPreRunE: storagePersistentPreRunE,
DisableAutoGenTag: true,
}
cmdWithConfigFlags(cmd, true, []string{"configuration.yml"})
@ -58,6 +60,8 @@ func newStorageEncryptionCmd() (cmd *cobra.Command) {
Short: cmdAutheliaStorageEncryptionShort,
Long: cmdAutheliaStorageEncryptionLong,
Example: cmdAutheliaStorageEncryptionExample,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -75,6 +79,8 @@ func newStorageEncryptionCheckCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageEncryptionCheckLong,
Example: cmdAutheliaStorageEncryptionCheckExample,
RunE: storageSchemaEncryptionCheckRunE,
DisableAutoGenTag: true,
}
cmd.Flags().Bool("verbose", false, "enables verbose checking of every row of encrypted data")
@ -89,6 +95,8 @@ func newStorageEncryptionChangeKeyCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageEncryptionChangeKeyLong,
Example: cmdAutheliaStorageEncryptionChangeKeyExample,
RunE: storageSchemaEncryptionChangeKeyRunE,
DisableAutoGenTag: true,
}
cmd.Flags().String("new-encryption-key", "", "the new key to encrypt the data with")
@ -102,6 +110,8 @@ func newStorageUserCmd() (cmd *cobra.Command) {
Short: cmdAutheliaStorageUserShort,
Long: cmdAutheliaStorageUserLong,
Example: cmdAutheliaStorageUserExample,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -118,6 +128,8 @@ func newStorageUserIdentifiersCmd() (cmd *cobra.Command) {
Short: cmdAutheliaStorageUserIdentifiersShort,
Long: cmdAutheliaStorageUserIdentifiersLong,
Example: cmdAutheliaStorageUserIdentifiersExample,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -137,6 +149,8 @@ func newStorageUserIdentifiersExportCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageUserIdentifiersExportLong,
Example: cmdAutheliaStorageUserIdentifiersExportExample,
RunE: storageUserIdentifiersExport,
DisableAutoGenTag: true,
}
cmd.Flags().StringP("file", "f", "user-opaque-identifiers.yml", "The file name for the YAML export")
@ -151,6 +165,8 @@ func newStorageUserIdentifiersImportCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageUserIdentifiersImportLong,
Example: cmdAutheliaStorageUserIdentifiersImportExample,
RunE: storageUserIdentifiersImport,
DisableAutoGenTag: true,
}
cmd.Flags().StringP("file", "f", "user-opaque-identifiers.yml", "The file name for the YAML import")
@ -165,6 +181,8 @@ func newStorageUserIdentifiersGenerateCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageUserIdentifiersGenerateLong,
Example: cmdAutheliaStorageUserIdentifiersGenerateExample,
RunE: storageUserIdentifiersGenerate,
DisableAutoGenTag: true,
}
cmd.Flags().StringSlice("users", nil, "The list of users to generate the opaque identifiers for")
@ -182,6 +200,8 @@ func newStorageUserIdentifiersAddCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageUserIdentifiersAddExample,
Args: cobra.ExactArgs(1),
RunE: storageUserIdentifiersAdd,
DisableAutoGenTag: true,
}
cmd.Flags().String("identifier", "", "The optional version 4 UUID to use, if not set a random one will be used")
@ -197,6 +217,8 @@ func newStorageUserTOTPCmd() (cmd *cobra.Command) {
Short: cmdAutheliaStorageUserTOTPShort,
Long: cmdAutheliaStorageUserTOTPLong,
Example: cmdAutheliaStorageUserTOTPExample,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -216,6 +238,8 @@ func newStorageUserTOTPGenerateCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageUserTOTPGenerateExample,
RunE: storageTOTPGenerateRunE,
Args: cobra.ExactArgs(1),
DisableAutoGenTag: true,
}
cmd.Flags().String("secret", "", "Optionally set the TOTP shared secret as base32 encoded bytes (no padding), it's recommended to not set this option unless you're restoring an TOTP config")
@ -238,6 +262,8 @@ func newStorageUserTOTPDeleteCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageUserTOTPDeleteExample,
RunE: storageTOTPDeleteRunE,
Args: cobra.ExactArgs(1),
DisableAutoGenTag: true,
}
return cmd
@ -250,6 +276,8 @@ func newStorageUserTOTPExportCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageUserTOTPExportLong,
Example: cmdAutheliaStorageUserTOTPExportExample,
RunE: storageTOTPExportRunE,
DisableAutoGenTag: true,
}
cmd.Flags().String("format", storageTOTPExportFormatURI, fmt.Sprintf("sets the output format, valid values are: %s", strings.Join(validStorageTOTPExportFormats, ", ")))
@ -265,6 +293,8 @@ func newStorageSchemaInfoCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageSchemaInfoLong,
Example: cmdAutheliaStorageSchemaInfoExample,
RunE: storageSchemaInfoRunE,
DisableAutoGenTag: true,
}
return cmd
@ -278,6 +308,8 @@ func newStorageMigrateCmd() (cmd *cobra.Command) {
Long: cmdAutheliaStorageMigrateLong,
Example: cmdAutheliaStorageMigrateExample,
Args: cobra.NoArgs,
DisableAutoGenTag: true,
}
cmd.AddCommand(
@ -297,6 +329,8 @@ func newStorageMigrateHistoryCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageMigrateHistoryExample,
Args: cobra.NoArgs,
RunE: storageMigrateHistoryRunE,
DisableAutoGenTag: true,
}
return cmd
@ -310,6 +344,8 @@ func newStorageMigrateListUpCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageMigrateListUpExample,
Args: cobra.NoArgs,
RunE: newStorageMigrateListRunE(true),
DisableAutoGenTag: true,
}
return cmd
@ -323,6 +359,8 @@ func newStorageMigrateListDownCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageMigrateListDownExample,
Args: cobra.NoArgs,
RunE: newStorageMigrateListRunE(false),
DisableAutoGenTag: true,
}
return cmd
@ -336,6 +374,8 @@ func newStorageMigrateUpCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageMigrateUpExample,
Args: cobra.NoArgs,
RunE: newStorageMigrationRunE(true),
DisableAutoGenTag: true,
}
cmd.Flags().IntP("target", "t", 0, "sets the version to migrate to, by default this is the latest version")
@ -351,6 +391,8 @@ func newStorageMigrateDownCmd() (cmd *cobra.Command) {
Example: cmdAutheliaStorageMigrateDownExample,
Args: cobra.NoArgs,
RunE: newStorageMigrationRunE(false),
DisableAutoGenTag: true,
}
cmd.Flags().IntP("target", "t", 0, "sets the version to migrate to")

2
internal/commands/validate.go
View File

@ -16,6 +16,8 @@ func newValidateConfigCmd() (cmd *cobra.Command) {
Example: cmdAutheliaValidateConfigExample,
Args: cobra.NoArgs,
RunE: cmdValidateConfigRunE,
DisableAutoGenTag: true,
}
cmdWithConfigFlags(cmd, false, []string{"configuration.yml"})