diff options
Diffstat (limited to 'docs/content/en/reference/cli')
63 files changed, 3351 insertions, 0 deletions
diff --git a/docs/content/en/reference/cli/_index.md b/docs/content/en/reference/cli/_index.md new file mode 100644 index 000000000..6cbd0a1e2 --- /dev/null +++ b/docs/content/en/reference/cli/_index.md @@ -0,0 +1,10 @@ +--- +title: "CLI" +description: "" +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +weight: 300 +toc: true +--- diff --git a/docs/content/en/reference/cli/authelia-gen/_index.md b/docs/content/en/reference/cli/authelia-gen/_index.md new file mode 100644 index 000000000..02b76ddeb --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/_index.md @@ -0,0 +1,14 @@ +--- +title: "authelia-gen" +description: "" +lead: "" +date: 2022-06-03T10:57:43+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli" + identifier: "cli-authelia-gen" +weight: 900 +toc: true +--- diff --git a/docs/content/en/reference/cli/authelia-gen/authelia-gen.md b/docs/content/en/reference/cli/authelia-gen/authelia-gen.md new file mode 100644 index 000000000..9f67ef67c --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/authelia-gen.md @@ -0,0 +1,31 @@ +--- +title: "authelia-gen" +description: "Reference for the authelia-gen command." +lead: "" +date: 2022-06-03T10:57:43+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-gen" +weight: 320 +toc: true +--- + +## authelia-gen + +Authelia's generator tooling + +### Options + +``` + -h, --help help for authelia-gen +``` + +### SEE ALSO + +* [authelia-gen all](authelia-gen_all.md) - Run all generators with default options +* [authelia-gen code](authelia-gen_code.md) - Generate code +* [authelia-gen docs](authelia-gen_docs.md) - Generate docs + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-gen/authelia-gen_all.md b/docs/content/en/reference/cli/authelia-gen/authelia-gen_all.md new file mode 100644 index 000000000..8af830638 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/authelia-gen_all.md @@ -0,0 +1,33 @@ +--- +title: "authelia-gen all" +description: "Reference for the authelia-gen all command." +lead: "" +date: 2022-06-03T10:57:43+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-gen" +weight: 330 +toc: true +--- + +## authelia-gen all + +Run all generators with default options + +``` +authelia-gen all [flags] +``` + +### Options + +``` + -h, --help help for all +``` + +### SEE ALSO + +* [authelia-gen](authelia-gen.md) - Authelia's generator tooling + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-gen/authelia-gen_code.md b/docs/content/en/reference/cli/authelia-gen/authelia-gen_code.md new file mode 100644 index 000000000..b065e6144 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/authelia-gen_code.md @@ -0,0 +1,34 @@ +--- +title: "authelia-gen code" +description: "Reference for the authelia-gen code command." +lead: "" +date: 2022-06-03T10:57:43+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-gen" +weight: 330 +toc: true +--- + +## authelia-gen code + +Generate code + +``` +authelia-gen code [flags] +``` + +### Options + +``` + -h, --help help for code +``` + +### SEE ALSO + +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-gen/authelia-gen_code_keys.md b/docs/content/en/reference/cli/authelia-gen/authelia-gen_code_keys.md new file mode 100644 index 000000000..59b40514f --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/authelia-gen_code_keys.md @@ -0,0 +1,35 @@ +--- +title: "authelia-gen code keys" +description: "Reference for the authelia-gen code keys command." +lead: "" +date: 2022-06-03T10:57:43+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-gen" +weight: 330 +toc: true +--- + +## authelia-gen code keys + +Generate the list of valid configuration keys + +``` +authelia-gen code keys [flags] +``` + +### Options + +``` + -f, --file string Sets the path of the keys file (default "./internal/configuration/schema/keys.go") + -h, --help help for keys + --package string Sets the package name of the keys file (default "schema") +``` + +### SEE ALSO + +* [authelia-gen code](authelia-gen_code.md) - Generate code + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs.md b/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs.md new file mode 100644 index 000000000..470c325eb --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs.md @@ -0,0 +1,36 @@ +--- +title: "authelia-gen docs" +description: "Reference for the authelia-gen docs command." +lead: "" +date: 2022-06-03T10:57:43+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-gen" +weight: 330 +toc: true +--- + +## authelia-gen docs + +Generate docs + +``` +authelia-gen docs [flags] +``` + +### Options + +``` + -C, --cwd string Sets the CWD for git commands + -h, --help help for docs +``` + +### SEE ALSO + +* [authelia-gen](authelia-gen.md) - Authelia's generator tooling +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_cli.md b/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_cli.md new file mode 100644 index 000000000..f9f82f88d --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_cli.md @@ -0,0 +1,40 @@ +--- +title: "authelia-gen docs cli" +description: "Reference for the authelia-gen docs cli command." +lead: "" +date: 2022-06-03T10:57:43+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-gen" +weight: 330 +toc: true +--- + +## authelia-gen docs cli + +Generate CLI docs + +``` +authelia-gen docs cli [flags] +``` + +### Options + +``` + -d, --directory string The directory to store the markdown in (default "./docs/content/en/reference/cli") + -h, --help help for cli +``` + +### Options inherited from parent commands + +``` + -C, --cwd string Sets the CWD for git commands +``` + +### SEE ALSO + +* [authelia-gen docs](authelia-gen_docs.md) - Generate docs + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_time.md b/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_time.md new file mode 100644 index 000000000..f9fd43925 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-gen/authelia-gen_docs_time.md @@ -0,0 +1,42 @@ +--- +title: "authelia-gen docs time" +description: "Reference for the authelia-gen docs time command." +lead: "" +date: 2022-06-03T11:17:29+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-gen" +weight: 330 +toc: true +--- + +## authelia-gen docs time + +Generate doc timestamps + +``` +authelia-gen docs time [flags] +``` + +### Options + +``` + --commit-since string The commit to check the logs since + --commit-until string The commit to check the logs until (default "HEAD") + -d, --directory string The directory to modify (default "./docs/content") + -h, --help help for time +``` + +### Options inherited from parent commands + +``` + -C, --cwd string Sets the CWD for git commands +``` + +### SEE ALSO + +* [authelia-gen docs](authelia-gen_docs.md) - Generate docs + +###### Auto generated by spf13/cobra on 12-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/_index.md b/docs/content/en/reference/cli/authelia-scripts/_index.md new file mode 100644 index 000000000..d5900faba --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/_index.md @@ -0,0 +1,14 @@ +--- +title: "authelia-scripts" +description: "" +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli" + identifier: "cli-authelia-scripts" +weight: 900 +toc: true +--- diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts.md new file mode 100644 index 000000000..1ca489024 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts.md @@ -0,0 +1,52 @@ +--- +title: "authelia-scripts" +description: "Reference for the authelia-scripts command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 320 +toc: true +--- + +## authelia-scripts + +A utility used in the Authelia development process. + +### Synopsis + +The authelia-scripts utility is utilized by developers and the CI/CD pipeline for configuring +testing suites and various other aspects of the environment. + +It can be used to automate or manually run unit testing, integration testing, etc. + +### Examples + +``` +authelia-scripts help +``` + +### Options + +``` + --buildkite Set CI flag for Buildkite + -h, --help help for authelia-scripts + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts bootstrap](authelia-scripts_bootstrap.md) - Prepare environment for development and testing +* [authelia-scripts build](authelia-scripts_build.md) - Build Authelia binary and static assets +* [authelia-scripts ci](authelia-scripts_ci.md) - Run the continuous integration script +* [authelia-scripts clean](authelia-scripts_clean.md) - Clean build artifacts +* [authelia-scripts docker](authelia-scripts_docker.md) - Commands related to building and publishing docker image +* [authelia-scripts serve](authelia-scripts_serve.md) - Serve compiled version of Authelia +* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_bootstrap.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_bootstrap.md new file mode 100644 index 000000000..f06f7d773 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_bootstrap.md @@ -0,0 +1,50 @@ +--- +title: "authelia-scripts bootstrap" +description: "Reference for the authelia-scripts bootstrap command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts bootstrap + +Prepare environment for development and testing + +### Synopsis + +Prepare environment for development and testing. + +``` +authelia-scripts bootstrap [flags] +``` + +### Examples + +``` +authelia-scripts bootstrap +``` + +### Options + +``` + -h, --help help for bootstrap +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_build.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_build.md new file mode 100644 index 000000000..959f7c64b --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_build.md @@ -0,0 +1,50 @@ +--- +title: "authelia-scripts build" +description: "Reference for the authelia-scripts build command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts build + +Build Authelia binary and static assets + +### Synopsis + +Build Authelia binary and static assets. + +``` +authelia-scripts build [flags] +``` + +### Examples + +``` +authelia-scripts build +``` + +### Options + +``` + -h, --help help for build +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_certificates.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_certificates.md new file mode 100644 index 000000000..5179e329e --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_certificates.md @@ -0,0 +1,39 @@ +--- +title: "authelia-scripts certificates" +description: "Reference for the authelia-scripts certificates command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +lastmod: 2022-06-03T11:17:29+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts certificates + +Commands related to certificate generation + +### Options + +``` + -h, --help help for certificates + --host strings Comma-separated hostnames and IPs to generate a certificate for +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - +* [authelia-scripts certificates generate](authelia-scripts_certificates_generate.md) - Generate a self-signed certificate + +###### Auto generated by spf13/cobra on 3-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_certificates_generate.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_certificates_generate.md new file mode 100644 index 000000000..462cb2d80 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_certificates_generate.md @@ -0,0 +1,49 @@ +--- +title: "authelia-scripts certificates generate" +description: "Reference for the authelia-scripts certificates generate command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +lastmod: 2022-06-03T11:17:29+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts certificates generate + +Generate a self-signed certificate + +``` +authelia-scripts certificates generate [flags] +``` + +### Options + +``` + --ca Whether this cert should be its own Certificate Authority + --dir string Target directory where the certificate and keys will be stored + --duration duration Duration that certificate is valid for (default 8760h0m0s) + --ecdsa-curve string ECDSA curve to use to generate a key. Valid values are P224, P256 (recommended), P384, P521 + --ed25519 Generate an Ed25519 key + -h, --help help for generate + --rsa-bits int Size of RSA key to generate. Ignored if --ecdsa-curve is set (default 2048) + --start-date string Creation date formatted as Jan 1 15:04:05 2011 +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --host strings Comma-separated hostnames and IPs to generate a certificate for + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts certificates](authelia-scripts_certificates.md) - Commands related to certificate generation + +###### Auto generated by spf13/cobra on 3-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_ci.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_ci.md new file mode 100644 index 000000000..2ff57852a --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_ci.md @@ -0,0 +1,50 @@ +--- +title: "authelia-scripts ci" +description: "Reference for the authelia-scripts ci command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts ci + +Run the continuous integration script + +### Synopsis + +Run the continuous integration script. + +``` +authelia-scripts ci [flags] +``` + +### Examples + +``` +authelia-scripts ci +``` + +### Options + +``` + -h, --help help for ci +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_clean.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_clean.md new file mode 100644 index 000000000..00bf92dcc --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_clean.md @@ -0,0 +1,50 @@ +--- +title: "authelia-scripts clean" +description: "Reference for the authelia-scripts clean command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts clean + +Clean build artifacts + +### Synopsis + +Clean build artifacts. + +``` +authelia-scripts clean [flags] +``` + +### Examples + +``` +authelia-scripts clean +``` + +### Options + +``` + -h, --help help for clean +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker.md new file mode 100644 index 000000000..864c0afc5 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker.md @@ -0,0 +1,52 @@ +--- +title: "authelia-scripts docker" +description: "Reference for the authelia-scripts docker command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts docker + +Commands related to building and publishing docker image + +### Synopsis + +Commands related to building and publishing docker image. + +``` +authelia-scripts docker [flags] +``` + +### Examples + +``` +authelia-scripts docker +``` + +### Options + +``` + -h, --help help for docker +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_build.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_build.md new file mode 100644 index 000000000..796797888 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_build.md @@ -0,0 +1,51 @@ +--- +title: "authelia-scripts docker build" +description: "Reference for the authelia-scripts docker build command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts docker build + +Build the docker image of Authelia + +### Synopsis + +Build the docker image of Authelia. + +``` +authelia-scripts docker build [flags] +``` + +### Examples + +``` +authelia-scripts docker build +``` + +### Options + +``` + --container string target container among: dev, coverage (default "dev") + -h, --help help for build +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts docker](authelia-scripts_docker.md) - Commands related to building and publishing docker image + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_push-manifest.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_push-manifest.md new file mode 100644 index 000000000..91c820afc --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_docker_push-manifest.md @@ -0,0 +1,50 @@ +--- +title: "authelia-scripts docker push-manifest" +description: "Reference for the authelia-scripts docker push-manifest command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts docker push-manifest + +Push Authelia docker manifest to the Docker registries + +### Synopsis + +Push Authelia docker manifest to the Docker registries. + +``` +authelia-scripts docker push-manifest [flags] +``` + +### Examples + +``` +authelia-scripts docker push-manifest +``` + +### Options + +``` + -h, --help help for push-manifest +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts docker](authelia-scripts_docker.md) - Commands related to building and publishing docker image + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_hash-password.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_hash-password.md new file mode 100644 index 000000000..8fc11527a --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_hash-password.md @@ -0,0 +1,49 @@ +--- +title: "authelia-scripts hash-password" +description: "Reference for the authelia-scripts hash-password command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +lastmod: 2022-06-03T11:17:29+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts hash-password + +Hash a password to be used in file-based users database. Default algorithm is argon2id. + +``` +authelia-scripts hash-password [flags] -- <password> +``` + +### Options + +``` + -c, --config strings Configuration files + -h, --help help for hash-password + -i, --iterations int set the number of hashing iterations (default 3) + -k, --key-length int [argon2id] set the key length param (default 32) + -m, --memory int [argon2id] set the amount of memory param (in MB) (default 64) + -p, --parallelism int [argon2id] set the parallelism param (default 4) + -s, --salt string set the salt string + -l, --salt-length int set the auto-generated salt length (default 16) + -z, --sha512 use sha512 as the algorithm (changes iterations to 50000, change with -i) +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - + +###### Auto generated by spf13/cobra on 3-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_rsa.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_rsa.md new file mode 100644 index 000000000..e12a7c54b --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_rsa.md @@ -0,0 +1,38 @@ +--- +title: "authelia-scripts rsa" +description: "Reference for the authelia-scripts rsa command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +lastmod: 2022-06-03T11:17:29+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts rsa + +Commands related to rsa keypair generation + +### Options + +``` + -h, --help help for rsa +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - +* [authelia-scripts rsa generate](authelia-scripts_rsa_generate.md) - Generate a RSA keypair + +###### Auto generated by spf13/cobra on 3-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_rsa_generate.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_rsa_generate.md new file mode 100644 index 000000000..353b7a1ab --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_rsa_generate.md @@ -0,0 +1,43 @@ +--- +title: "authelia-scripts rsa generate" +description: "Reference for the authelia-scripts rsa generate command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +lastmod: 2022-06-03T11:17:29+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts rsa generate + +Generate a RSA keypair + +``` +authelia-scripts rsa generate [flags] +``` + +### Options + +``` + -d, --dir string Target directory where the keypair will be stored + -h, --help help for generate + -b, --key-size int Sets the key size in bits (default 2048) +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts rsa](authelia-scripts_rsa.md) - Commands related to rsa keypair generation + +###### Auto generated by spf13/cobra on 3-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_serve.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_serve.md new file mode 100644 index 000000000..b7a4b68eb --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_serve.md @@ -0,0 +1,50 @@ +--- +title: "authelia-scripts serve" +description: "Reference for the authelia-scripts serve command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts serve + +Serve compiled version of Authelia + +### Synopsis + +Serve compiled version of Authelia. + +``` +authelia-scripts serve [config] [flags] +``` + +### Examples + +``` +authelia-scripts serve test.yml +``` + +### Options + +``` + -h, --help help for serve +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites.md new file mode 100644 index 000000000..b95dbbc6c --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites.md @@ -0,0 +1,54 @@ +--- +title: "authelia-scripts suites" +description: "Reference for the authelia-scripts suites command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts suites + +Commands related to suites management + +### Synopsis + +Commands related to suites management. + +``` +authelia-scripts suites [flags] +``` + +### Examples + +``` +authelia-scripts suites +``` + +### Options + +``` + -h, --help help for suites +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. +* [authelia-scripts suites list](authelia-scripts_suites_list.md) - List available suites +* [authelia-scripts suites setup](authelia-scripts_suites_setup.md) - Setup a test suite environment +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_list.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_list.md new file mode 100644 index 000000000..6f6890c2d --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_list.md @@ -0,0 +1,52 @@ +--- +title: "authelia-scripts suites list" +description: "Reference for the authelia-scripts suites list command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts suites list + +List available suites + +### Synopsis + +List available suites. + +Suites can be ran with the authelia-scripts suites test [suite] command. + +``` +authelia-scripts suites list [flags] +``` + +### Examples + +``` +authelia-scripts suites list +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_setup.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_setup.md new file mode 100644 index 000000000..cd18eb486 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_setup.md @@ -0,0 +1,52 @@ +--- +title: "authelia-scripts suites setup" +description: "Reference for the authelia-scripts suites setup command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts suites setup + +Setup a test suite environment + +### Synopsis + +Setup a test suite environment. + +Suites can be listed with the authelia-scripts suites list command. + +``` +authelia-scripts suites setup [suite] [flags] +``` + +### Examples + +``` +authelia-scripts suites setup Standalone +``` + +### Options + +``` + -h, --help help for setup +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_teardown.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_teardown.md new file mode 100644 index 000000000..684c353c1 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_teardown.md @@ -0,0 +1,52 @@ +--- +title: "authelia-scripts suites teardown" +description: "Reference for the authelia-scripts suites teardown command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts suites teardown + +Teardown a test suite environment + +### Synopsis + +Teardown a test suite environment. + +Suites can be listed with the authelia-scripts suites list command. + +``` +authelia-scripts suites teardown [suite] [flags] +``` + +### Examples + +``` +authelia-scripts suites setup Standalone +``` + +### Options + +``` + -h, --help help for teardown +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_test.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_test.md new file mode 100644 index 000000000..40107937f --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_suites_test.md @@ -0,0 +1,55 @@ +--- +title: "authelia-scripts suites test" +description: "Reference for the authelia-scripts suites test command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts suites test + +Run a test suite + +### Synopsis + +Run a test suite. + +Suites can be listed with the authelia-scripts suites list command. + +``` +authelia-scripts suites test [suite] [flags] +``` + +### Examples + +``` +authelia-scripts suites test Standalone +``` + +### Options + +``` + --failfast Stops tests on first failure + --headless Run tests in headless mode + -h, --help help for test + --test string The single test to run +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts suites](authelia-scripts_suites.md) - Commands related to suites management + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_unittest.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_unittest.md new file mode 100644 index 000000000..cab5550d1 --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_unittest.md @@ -0,0 +1,50 @@ +--- +title: "authelia-scripts unittest" +description: "Reference for the authelia-scripts unittest command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts unittest + +Run unit tests + +### Synopsis + +Run unit tests. + +``` +authelia-scripts unittest [flags] +``` + +### Examples + +``` +authelia-scripts unittest +``` + +### Options + +``` + -h, --help help for unittest +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_xflags.md b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_xflags.md new file mode 100644 index 000000000..faa84356e --- /dev/null +++ b/docs/content/en/reference/cli/authelia-scripts/authelia-scripts_xflags.md @@ -0,0 +1,52 @@ +--- +title: "authelia-scripts xflags" +description: "Reference for the authelia-scripts xflags command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia-scripts" +weight: 330 +toc: true +--- + +## authelia-scripts xflags + +Generate X LDFlags for building Authelia + +### Synopsis + +Generate X LDFlags for building Authelia. + +``` +authelia-scripts xflags [flags] +``` + +### Examples + +``` +authelia-scripts xflags +``` + +### Options + +``` + -b, --build string Sets the BuildNumber flag value (default "0") + -e, --extra string Sets the BuildExtra flag value + -h, --help help for xflags +``` + +### Options inherited from parent commands + +``` + --buildkite Set CI flag for Buildkite + --log-level string Set the log level for the command (default "info") +``` + +### SEE ALSO + +* [authelia-scripts](authelia-scripts.md) - A utility used in the Authelia development process. + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/_index.md b/docs/content/en/reference/cli/authelia/_index.md new file mode 100644 index 000000000..012ba9930 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/_index.md @@ -0,0 +1,14 @@ +--- +title: "authelia" +description: "" +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli" + identifier: "cli-authelia" +weight: 320 +toc: true +--- diff --git a/docs/content/en/reference/cli/authelia/authelia.md b/docs/content/en/reference/cli/authelia/authelia.md new file mode 100644 index 000000000..5bfeff7b5 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia.md @@ -0,0 +1,58 @@ +--- +title: "authelia" +description: "Reference for the authelia command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 320 +toc: true +--- + +## authelia + +authelia untagged-unknown-dirty (master, unknown) + +### Synopsis + +authelia untagged-unknown-dirty (master, unknown) + +An open-source authentication and authorization server providing +two-factor authentication and single sign-on (SSO) for your +applications via a web portal. + +Documentation is available at: https://www.authelia.com/docs + +``` +authelia [flags] +``` + +### Examples + +``` +authelia --config /etc/authelia/config.yml --config /etc/authelia/access-control.yml +authelia --config /etc/authelia/config.yml,/etc/authelia/access-control.yml +authelia --config /etc/authelia/config/ +``` + +### Options + +``` + -c, --config strings configuration files to load + -h, --help help for authelia +``` + +### SEE ALSO + +* [authelia access-control](authelia_access-control.md) - Helpers for the access control system +* [authelia build-info](authelia_build-info.md) - Show the build information of Authelia +* [authelia certificates](authelia_certificates.md) - Commands related to certificate generation +* [authelia hash-password](authelia_hash-password.md) - Hash a password to be used in file-based users database. +* [authelia rsa](authelia_rsa.md) - Commands related to rsa keypair generation +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_access-control.md b/docs/content/en/reference/cli/authelia/authelia_access-control.md new file mode 100644 index 000000000..d525b6585 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_access-control.md @@ -0,0 +1,40 @@ +--- +title: "authelia access-control" +description: "Reference for the authelia access-control command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia access-control + +Helpers for the access control system + +### Synopsis + +Helpers for the access control system. + +### Examples + +``` +authelia access-control --help +``` + +### Options + +``` + -h, --help help for access-control +``` + +### SEE ALSO + +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_access-control_check-policy.md b/docs/content/en/reference/cli/authelia/authelia_access-control_check-policy.md new file mode 100644 index 000000000..fbfba5fe5 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_access-control_check-policy.md @@ -0,0 +1,70 @@ +--- +title: "authelia access-control check-policy" +description: "Reference for the authelia access-control check-policy command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia access-control check-policy + +Checks a request against the access control rules to determine what policy would be applied + +### Synopsis + + +Checks a request against the access control rules to determine what policy would be applied. + +Legend: + + # The rule position in the configuration. + * The first fully matched rule. + ~ Potential match i.e. if the user was authenticated they may match this rule. + hit The criteria in this column is a match to the request. + miss The criteria in this column is not match to the request. + may The criteria in this column is potentially a match to the request. + +Notes: + + A rule that potentially matches a request will cause a redirection to occur in order to perform one-factor + authentication. This is so Authelia can adequately determine if the rule actually matches. + + +``` +authelia access-control check-policy [flags] +``` + +### Examples + +``` +authelia access-control check-policy --config config.yml --url https://example.com +authelia access-control check-policy --config config.yml --url https://example.com --username john +authelia access-control check-policy --config config.yml --url https://example.com --groups admin,public +authelia access-control check-policy --config config.yml --url https://example.com --username john --method GET +authelia access-control check-policy --config config.yml --url https://example.com --username john --method GET --verbose +``` + +### Options + +``` + -c, --config strings configuration files to load (default [config.yml]) + --groups strings the groups of the subject + -h, --help help for check-policy + --ip string the ip of the subject + --method string the HTTP method of the object (default "GET") + --url string the url of the object + --username string the username of the subject + --verbose enables verbose output +``` + +### SEE ALSO + +* [authelia access-control](authelia_access-control.md) - Helpers for the access control system + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_build-info.md b/docs/content/en/reference/cli/authelia/authelia_build-info.md new file mode 100644 index 000000000..20c17b546 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_build-info.md @@ -0,0 +1,52 @@ +--- +title: "authelia build-info" +description: "Reference for the authelia build-info command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia build-info + +Show the build information of Authelia + +### Synopsis + +Show the build information of Authelia. + +This outputs detailed version information about the specific version +of the Authelia binary. This information is embedded into Authelia +by the continuous integration. + +This could be vital in debugging if you're not using a particular +tagged build of Authelia. It's suggested to provide it along with +your issue. + + +``` +authelia build-info [flags] +``` + +### Examples + +``` +authelia build-info +``` + +### Options + +``` + -h, --help help for build-info +``` + +### SEE ALSO + +* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown) + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_certificates.md b/docs/content/en/reference/cli/authelia/authelia_certificates.md new file mode 100644 index 000000000..8583c53ff --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_certificates.md @@ -0,0 +1,43 @@ +--- +title: "authelia certificates" +description: "Reference for the authelia certificates command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia certificates + +Commands related to certificate generation + +### Synopsis + +Commands related to certificate generation. + +This subcommand allows preforming X509 certificate tasks. + +### Examples + +``` +authelia certificates --help +``` + +### Options + +``` + -h, --help help for certificates + --host strings Comma-separated hostnames and IPs to generate a certificate for +``` + +### SEE ALSO + +* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown) +* [authelia certificates generate](authelia_certificates_generate.md) - Generate a self-signed certificate + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_certificates_generate.md b/docs/content/en/reference/cli/authelia/authelia_certificates_generate.md new file mode 100644 index 000000000..672549c5f --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_certificates_generate.md @@ -0,0 +1,59 @@ +--- +title: "authelia certificates generate" +description: "Reference for the authelia certificates generate command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia certificates generate + +Generate a self-signed certificate + +### Synopsis + +Generate a self-signed certificate. + +This subcommand allows generating self-signed certificates. + +``` +authelia certificates generate [flags] +``` + +### Examples + +``` +authelia certificates generate +authelia certificates generate --dir ./out +``` + +### Options + +``` + --ca Whether this cert should be its own Certificate Authority + --dir string Target directory where the certificate and keys will be stored + --duration duration Duration that certificate is valid for (default 8760h0m0s) + --ecdsa-curve string ECDSA curve to use to generate a key. Valid values are P224, P256 (recommended), P384, P521 + --ed25519 Generate an Ed25519 key + -h, --help help for generate + --rsa-bits int Size of RSA key to generate. Ignored if --ecdsa-curve is set (default 2048) + --start-date string Creation date formatted as Jan 1 15:04:05 2011 +``` + +### Options inherited from parent commands + +``` + --host strings Comma-separated hostnames and IPs to generate a certificate for +``` + +### SEE ALSO + +* [authelia certificates](authelia_certificates.md) - Commands related to certificate generation + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_hash-password.md b/docs/content/en/reference/cli/authelia/authelia_hash-password.md new file mode 100644 index 000000000..cd66e6de8 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_hash-password.md @@ -0,0 +1,56 @@ +--- +title: "authelia hash-password" +description: "Reference for the authelia hash-password command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia hash-password + +Hash a password to be used in file-based users database. + +### Synopsis + +Hash a password to be used in file-based users database. + +``` +authelia hash-password [flags] -- <password> +``` + +### Examples + +``` +authelia hash-password -- 'mypass' +authelia hash-password --sha512 -- 'mypass' +authelia hash-password --iterations=4 -- 'mypass' +authelia hash-password --memory=128 -- 'mypass' +authelia hash-password --parallelism=1 -- 'mypass' +authelia hash-password --key-length=64 -- 'mypass' +``` + +### Options + +``` + -c, --config strings Configuration files + -h, --help help for hash-password + -i, --iterations int set the number of hashing iterations (default 3) + -k, --key-length int [argon2id] set the key length param (default 32) + -m, --memory int [argon2id] set the amount of memory param (in MB) (default 64) + -p, --parallelism int [argon2id] set the parallelism param (default 4) + -s, --salt string set the salt string + -l, --salt-length int set the auto-generated salt length (default 16) + -z, --sha512 use sha512 as the algorithm (changes iterations to 50000, change with -i) +``` + +### SEE ALSO + +* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown) + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_rsa.md b/docs/content/en/reference/cli/authelia/authelia_rsa.md new file mode 100644 index 000000000..ea3b6469b --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_rsa.md @@ -0,0 +1,42 @@ +--- +title: "authelia rsa" +description: "Reference for the authelia rsa command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia rsa + +Commands related to rsa keypair generation + +### Synopsis + +Commands related to rsa keypair generation. + +This subcommand allows performing RSA keypair tasks. + +### Examples + +``` +authelia rsa --help +``` + +### Options + +``` + -h, --help help for rsa +``` + +### SEE ALSO + +* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown) +* [authelia rsa generate](authelia_rsa_generate.md) - Generate a RSA keypair + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_rsa_generate.md b/docs/content/en/reference/cli/authelia/authelia_rsa_generate.md new file mode 100644 index 000000000..9b80d345c --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_rsa_generate.md @@ -0,0 +1,48 @@ +--- +title: "authelia rsa generate" +description: "Reference for the authelia rsa generate command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia rsa generate + +Generate a RSA keypair + +### Synopsis + +Generate a RSA keypair. + +This subcommand allows generating an RSA keypair. + +``` +authelia rsa generate [flags] +``` + +### Examples + +``` +authelia rsa generate +authelia rsa generate --dir ./out +``` + +### Options + +``` + -d, --dir string Target directory where the keypair will be stored + -h, --help help for generate + -b, --key-size int Sets the key size in bits (default 2048) +``` + +### SEE ALSO + +* [authelia rsa](authelia_rsa.md) - Commands related to rsa keypair generation + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage.md b/docs/content/en/reference/cli/authelia/authelia_storage.md new file mode 100644 index 000000000..0423b9b68 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage.md @@ -0,0 +1,65 @@ +--- +title: "authelia storage" +description: "Reference for the authelia storage command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage + +Manage the Authelia storage + +### Synopsis + +Manage the Authelia storage. + +This subcommand has several methods to interact with the Authelia SQL Database. This allows doing several advanced +operations which would be much harder to do manually. + + +### Examples + +``` +authelia storage --help +``` + +### Options + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + -h, --help help for storage + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown) +* [authelia storage encryption](authelia_storage_encryption.md) - Manage storage encryption +* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_encryption.md b/docs/content/en/reference/cli/authelia/authelia_storage_encryption.md new file mode 100644 index 000000000..a119ec7f4 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_encryption.md @@ -0,0 +1,66 @@ +--- +title: "authelia storage encryption" +description: "Reference for the authelia storage encryption command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage encryption + +Manage storage encryption + +### Synopsis + +Manage storage encryption. + +This subcommand allows management of the storage encryption. + +### Examples + +``` +authelia storage encryption --help +``` + +### Options + +``` + -h, --help help for encryption +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage](authelia_storage.md) - Manage the Authelia storage +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_encryption_change-key.md b/docs/content/en/reference/cli/authelia/authelia_storage_encryption_change-key.md new file mode 100644 index 000000000..f6fb2d41e --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_encryption_change-key.md @@ -0,0 +1,70 @@ +--- +title: "authelia storage encryption change-key" +description: "Reference for the authelia storage encryption change-key command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage encryption change-key + +Changes the encryption key + +### Synopsis + +Changes the encryption key. + +This subcommand allows you to change the encryption key of an Authelia SQL database. + +``` +authelia storage encryption change-key [flags] +``` + +### Examples + +``` +authelia storage encryption change-key --config config.yml --new-encryption-key 0e95cb49-5804-4ad9-be82-bb04a9ddecd8 +authelia storage encryption change-key --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --new-encryption-key 0e95cb49-5804-4ad9-be82-bb04a9ddecd8 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for change-key + --new-encryption-key string the new key to encrypt the data with +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage encryption](authelia_storage_encryption.md) - Manage storage encryption + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_encryption_check.md b/docs/content/en/reference/cli/authelia/authelia_storage_encryption_check.md new file mode 100644 index 000000000..96c225e87 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_encryption_check.md @@ -0,0 +1,72 @@ +--- +title: "authelia storage encryption check" +description: "Reference for the authelia storage encryption check command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage encryption check + +Checks the encryption key against the database data + +### Synopsis + +Checks the encryption key against the database data. + +This is useful for validating all data that can be encrypted is intact. + +``` +authelia storage encryption check [flags] +``` + +### Examples + +``` +authelia storage encryption check +authelia storage encryption check --verbose +authelia storage encryption check --verbose --config config.yml +authelia storage encryption check --verbose --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for check + --verbose enables verbose checking of every row of encrypted data +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage encryption](authelia_storage_encryption.md) - Manage storage encryption + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_migrate.md b/docs/content/en/reference/cli/authelia/authelia_storage_migrate.md new file mode 100644 index 000000000..383f29757 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_migrate.md @@ -0,0 +1,69 @@ +--- +title: "authelia storage migrate" +description: "Reference for the authelia storage migrate command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage migrate + +Perform or list migrations + +### Synopsis + +Perform or list migrations. + +This subcommand handles schema migration tasks. + +### Examples + +``` +authelia storage migrate --help +``` + +### Options + +``` + -h, --help help for migrate +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage](authelia_storage.md) - Manage the Authelia storage +* [authelia storage migrate down](authelia_storage_migrate_down.md) - Perform a migration down +* [authelia storage migrate history](authelia_storage_migrate_history.md) - Show migration history +* [authelia storage migrate list-down](authelia_storage_migrate_list-down.md) - List the down migrations available +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_migrate_down.md b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_down.md new file mode 100644 index 000000000..07ee94ffc --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_down.md @@ -0,0 +1,74 @@ +--- +title: "authelia storage migrate down" +description: "Reference for the authelia storage migrate down command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage migrate down + +Perform a migration down + +### Synopsis + +Perform a migration down. + +This subcommand performs the schema migrations available in this version of Authelia which are less than the current +schema version of the database. + +``` +authelia storage migrate down [flags] +``` + +### Examples + +``` +authelia storage migrate down --target 20 +authelia storage migrate down --target 20 --config config.yml +authelia storage migrate down --target 20 --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + --destroy-data confirms you want to destroy data with this migration + -h, --help help for down + --pre1 sets pre1 as the version to migrate to + -t, --target int sets the version to migrate to +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_migrate_history.md b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_history.md new file mode 100644 index 000000000..c1b5af4ea --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_history.md @@ -0,0 +1,70 @@ +--- +title: "authelia storage migrate history" +description: "Reference for the authelia storage migrate history command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage migrate history + +Show migration history + +### Synopsis + +Show migration history. + +This subcommand allows users to list previous migrations. + +``` +authelia storage migrate history [flags] +``` + +### Examples + +``` +authelia storage migrate history +authelia storage migrate history --config config.yml +authelia storage migrate history --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for history +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-down.md b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-down.md new file mode 100644 index 000000000..b1d8f0481 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-down.md @@ -0,0 +1,71 @@ +--- +title: "authelia storage migrate list-down" +description: "Reference for the authelia storage migrate list-down command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage migrate list-down + +List the down migrations available + +### Synopsis + +List the down migrations available. + +This subcommand lists the schema migrations available in this version of Authelia which are less than the current +schema version of the database. + +``` +authelia storage migrate list-down [flags] +``` + +### Examples + +``` +authelia storage migrate list-down +authelia storage migrate list-down --config config.yml +authelia storage migrate list-down --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for list-down +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-up.md b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-up.md new file mode 100644 index 000000000..075ef56a2 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_list-up.md @@ -0,0 +1,71 @@ +--- +title: "authelia storage migrate list-up" +description: "Reference for the authelia storage migrate list-up command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage migrate list-up + +List the up migrations available + +### Synopsis + +List the up migrations available. + +This subcommand lists the schema migrations available in this version of Authelia which are greater than the current +schema version of the database. + +``` +authelia storage migrate list-up [flags] +``` + +### Examples + +``` +authelia storage migrate list-up +authelia storage migrate list-up --config config.yml +authelia storage migrate list-up --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for list-up +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_migrate_up.md b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_up.md new file mode 100644 index 000000000..bd3d19fb0 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_migrate_up.md @@ -0,0 +1,73 @@ +--- +title: "authelia storage migrate up" +description: "Reference for the authelia storage migrate up command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage migrate up + +Perform a migration up + +### Synopsis + +Perform a migration up. + +This subcommand performs the schema migrations available in this version of Authelia which are greater than the current +schema version of the database. By default this will migrate up to the latest available, but you can customize this. + +``` +authelia storage migrate up [flags] +``` + +### Examples + +``` +authelia storage migrate up +authelia storage migrate up --config config.yml +authelia storage migrate up --target 20 --config config.yml +authelia storage migrate up --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for up + -t, --target int sets the version to migrate to, by default this is the latest version +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage migrate](authelia_storage_migrate.md) - Perform or list migrations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_schema-info.md b/docs/content/en/reference/cli/authelia/authelia_storage_schema-info.md new file mode 100644 index 000000000..08a1a7cd8 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_schema-info.md @@ -0,0 +1,70 @@ +--- +title: "authelia storage schema-info" +description: "Reference for the authelia storage schema-info command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage schema-info + +Show the storage information + +### Synopsis + +Show the storage information. + +This subcommand shows advanced information about the storage schema useful in some diagnostic tasks. + +``` +authelia storage schema-info [flags] +``` + +### Examples + +``` +authelia storage schema-info +authelia storage schema-info --config config.yml +authelia storage schema-info --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for schema-info +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage](authelia_storage.md) - Manage the Authelia storage + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user.md b/docs/content/en/reference/cli/authelia/authelia_storage_user.md new file mode 100644 index 000000000..31ff94c2f --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user.md @@ -0,0 +1,66 @@ +--- +title: "authelia storage user" +description: "Reference for the authelia storage user command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user + +Manages user settings + +### Synopsis + +Manages user settings. + +This subcommand allows modifying and exporting user settings. + +### Examples + +``` +authelia storage user --help +``` + +### Options + +``` + -h, --help help for user +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage](authelia_storage.md) - Manage the Authelia storage +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers.md new file mode 100644 index 000000000..c5c853ece --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers.md @@ -0,0 +1,68 @@ +--- +title: "authelia storage user identifiers" +description: "Reference for the authelia storage user identifiers command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user identifiers + +Manage user opaque identifiers + +### Synopsis + +Manage user opaque identifiers. + +This subcommand allows performing various tasks related to the opaque identifiers for users. + +### Examples + +``` +authelia storage user identifiers --help +``` + +### Options + +``` + -h, --help help for identifiers +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user](authelia_storage_user.md) - Manages user settings +* [authelia storage user identifiers add](authelia_storage_user_identifiers_add.md) - Add an opaque identifier for a user to the database +* [authelia storage user identifiers export](authelia_storage_user_identifiers_export.md) - Export the identifiers to a YAML file +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_add.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_add.md new file mode 100644 index 000000000..7ca3f171c --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_add.md @@ -0,0 +1,73 @@ +--- +title: "authelia storage user identifiers add" +description: "Reference for the authelia storage user identifiers add command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user identifiers add + +Add an opaque identifier for a user to the database + +### Synopsis + +Add an opaque identifier for a user to the database. + +This subcommand allows manually adding an opaque identifier for a user to the database provided it's in the correct format. + +``` +authelia storage user identifiers add <username> [flags] +``` + +### Examples + +``` +authelia storage user identifiers add john --identifier f0919359-9d15-4e15-bcba-83b41620a073 +authelia storage user identifiers add john --identifier f0919359-9d15-4e15-bcba-83b41620a073 --config config.yml +authelia storage user identifiers add john --identifier f0919359-9d15-4e15-bcba-83b41620a073 --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for add + --identifier string The optional version 4 UUID to use, if not set a random one will be used + --sector string The sector identifier to use (should usually be blank) + --service string The service to add the identifier for, valid values are: openid (default "openid") +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_export.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_export.md new file mode 100644 index 000000000..325a1c7b4 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_export.md @@ -0,0 +1,72 @@ +--- +title: "authelia storage user identifiers export" +description: "Reference for the authelia storage user identifiers export command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user identifiers export + +Export the identifiers to a YAML file + +### Synopsis + +Export the identifiers to a YAML file. + +This subcommand allows exporting the opaque identifiers for users in order to back them up. + +``` +authelia storage user identifiers export [flags] +``` + +### Examples + +``` +authelia storage user identifiers export +authelia storage user identifiers export --file export.yaml +authelia storage user identifiers export --file export.yaml --config config.yml +authelia storage user identifiers export --file export.yaml --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -f, --file string The file name for the YAML export (default "user-opaque-identifiers.yml") + -h, --help help for export +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_generate.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_generate.md new file mode 100644 index 000000000..5f6fd17c8 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_generate.md @@ -0,0 +1,75 @@ +--- +title: "authelia storage user identifiers generate" +description: "Reference for the authelia storage user identifiers generate command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user identifiers generate + +Generate opaque identifiers in bulk + +### Synopsis + +Generate opaque identifiers in bulk. + +This subcommand allows various options for generating the opaque identifies for users in bulk. + +``` +authelia storage user identifiers generate [flags] +``` + +### Examples + +``` +authelia storage user identifiers generate --users john,mary +authelia storage user identifiers generate --users john,mary --services openid +authelia storage user identifiers generate --users john,mary --services openid --sectors=",example.com,test.com" +authelia storage user identifiers generate --users john,mary --services openid --sectors=",example.com,test.com" --config config.yml +authelia storage user identifiers generate --users john,mary --services openid --sectors=",example.com,test.com" --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for generate + --sectors strings The list of sectors to generate identifiers for + --services strings The list of services to generate the opaque identifiers for, valid values are: openid (default [openid]) + --users strings The list of users to generate the opaque identifiers for +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_import.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_import.md new file mode 100644 index 000000000..cdd838cd2 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_identifiers_import.md @@ -0,0 +1,75 @@ +--- +title: "authelia storage user identifiers import" +description: "Reference for the authelia storage user identifiers import command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user identifiers import + +Import the identifiers from a YAML file + +### Synopsis + +Import the identifiers from a YAML file. + +This subcommand allows you to import the opaque identifiers for users from a YAML file. + +The YAML file can either be automatically generated using the authelia storage user identifiers export command, or +manually provided the file is in the same format. + +``` +authelia storage user identifiers import [flags] +``` + +### Examples + +``` +authelia storage user identifiers import +authelia storage user identifiers import --file export.yaml +authelia storage user identifiers import --file export.yaml --config config.yml +authelia storage user identifiers import --file export.yaml --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -f, --file string The file name for the YAML import (default "user-opaque-identifiers.yml") + -h, --help help for import +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user identifiers](authelia_storage_user_identifiers.md) - Manage user opaque identifiers + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_totp.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp.md new file mode 100644 index 000000000..caf7c97a6 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp.md @@ -0,0 +1,67 @@ +--- +title: "authelia storage user totp" +description: "Reference for the authelia storage user totp command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user totp + +Manage TOTP configurations + +### Synopsis + +Manage TOTP configurations. + +This subcommand allows deleting, exporting, and creating user TOTP configurations. + +### Examples + +``` +authelia storage user totp --help +``` + +### Options + +``` + -h, --help help for totp +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user](authelia_storage_user.md) - Manages user settings +* [authelia storage user totp delete](authelia_storage_user_totp_delete.md) - Delete a TOTP configuration for a user +* [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 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_delete.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_delete.md new file mode 100644 index 000000000..6d0becae9 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_delete.md @@ -0,0 +1,70 @@ +--- +title: "authelia storage user totp delete" +description: "Reference for the authelia storage user totp delete command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user totp delete + +Delete a TOTP configuration for a user + +### Synopsis + +Delete a TOTP configuration for a user. + +This subcommand allows deleting a TOTP configuration directly from the database for a given user. + +``` +authelia storage user totp delete <username> [flags] +``` + +### Examples + +``` +authelia storage user totp delete john +authelia storage user totp delete john --config config.yml +authelia storage user totp delete john --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user totp](authelia_storage_user_totp.md) - Manage TOTP configurations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_export.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_export.md new file mode 100644 index 000000000..1d186d978 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_export.md @@ -0,0 +1,73 @@ +--- +title: "authelia storage user totp export" +description: "Reference for the authelia storage user totp export command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user totp export + +Perform exports of the TOTP configurations + +### Synopsis + +Perform exports of the TOTP configurations. + +This subcommand allows exporting TOTP configurations to various formats. + +``` +authelia storage user totp export [flags] +``` + +### Examples + +``` +authelia storage user totp export --format csv +authelia storage user totp export --format png --dir ./totp-qr +authelia storage user totp export --format png --dir ./totp-qr --config config.yml +authelia storage user totp export --format png --dir ./totp-qr --encryption-key b3453fde-ecc2-4a1f-9422-2707ddbed495 --postgres.host postgres --postgres.password autheliapw +``` + +### Options + +``` + --dir string used with the png output format to specify which new directory to save the files in + --format string sets the output format, valid values are: csv, uri, png (default "uri") + -h, --help help for export +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user totp](authelia_storage_user_totp.md) - Manage TOTP configurations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md new file mode 100644 index 000000000..23346f7c4 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_storage_user_totp_generate.md @@ -0,0 +1,82 @@ +--- +title: "authelia storage user totp generate" +description: "Reference for the authelia storage user totp generate command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia storage user totp generate + +Generate a TOTP configuration for a user + +### Synopsis + +Generate a TOTP configuration for a user. + +This subcommand allows generating a new TOTP configuration for a user, +and overwriting the existing configuration if applicable. + +``` +authelia storage user totp generate <username> [flags] +``` + +### Examples + +``` +authelia storage user totp generate john +authelia storage user totp generate john --period 90 +authelia storage user totp generate john --digits 8 +authelia storage user totp generate john --algorithm SHA512 +authelia storage user totp generate john --algorithm SHA512 --config config.yml +authelia storage user totp generate john --algorithm SHA512 --config config.yml --path john.png +``` + +### Options + +``` + --algorithm string set the TOTP algorithm (default "SHA1") + --digits uint set the TOTP digits (default 6) + -f, --force forces the TOTP configuration to be generated regardless if it exists or not + -h, --help help for generate + --issuer string set the TOTP issuer (default "Authelia") + -p, --path string path to a file to create a PNG file with the QR code (optional) + --period uint set the TOTP period (default 30) + --secret string 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 + --secret-size uint set the TOTP secret size (default 32) +``` + +### Options inherited from parent commands + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + --encryption-key string the storage encryption key to use + --mysql.database string the MySQL database name (default "authelia") + --mysql.host string the MySQL hostname + --mysql.password string the MySQL password + --mysql.port int the MySQL port (default 3306) + --mysql.username string the MySQL username (default "authelia") + --postgres.database string the PostgreSQL database name (default "authelia") + --postgres.host string the PostgreSQL hostname + --postgres.password string the PostgreSQL password + --postgres.port int the PostgreSQL port (default 5432) + --postgres.schema string the PostgreSQL schema name (default "public") + --postgres.ssl.certificate string the PostgreSQL ssl certificate file location + --postgres.ssl.key string the PostgreSQL ssl key file location + --postgres.ssl.mode string the PostgreSQL ssl mode (default "disable") + --postgres.ssl.root_certificate string the PostgreSQL ssl root certificate file location + --postgres.username string the PostgreSQL username (default "authelia") + --sqlite.path string the SQLite database path +``` + +### SEE ALSO + +* [authelia storage user totp](authelia_storage_user_totp.md) - Manage TOTP configurations + +###### Auto generated by spf13/cobra on 13-Jun-2022 diff --git a/docs/content/en/reference/cli/authelia/authelia_validate-config.md b/docs/content/en/reference/cli/authelia/authelia_validate-config.md new file mode 100644 index 000000000..a7a4a9842 --- /dev/null +++ b/docs/content/en/reference/cli/authelia/authelia_validate-config.md @@ -0,0 +1,48 @@ +--- +title: "authelia validate-config" +description: "Reference for the authelia validate-config command." +lead: "" +date: 2022-05-31T11:13:56+10:00 +draft: false +images: [] +menu: + reference: + parent: "cli-authelia" +weight: 330 +toc: true +--- + +## authelia validate-config + +Check a configuration against the internal configuration validation mechanisms + +### Synopsis + +Check a configuration against the internal configuration validation mechanisms. + +This subcommand allows validation of the YAML and Environment configurations so that a configuration can be checked +prior to deploying it. + +``` +authelia validate-config [flags] +``` + +### Examples + +``` +authelia validate-config +authelia validate-config --config config.yml +``` + +### Options + +``` + -c, --config strings configuration files to load (default [configuration.yml]) + -h, --help help for validate-config +``` + +### SEE ALSO + +* [authelia](authelia.md) - authelia untagged-unknown-dirty (master, unknown) + +###### Auto generated by spf13/cobra on 13-Jun-2022 |