diff --git a/.buildkite/deployment.yml b/.buildkite/deployment.yml index 2d0985569..ad54f8cf1 100644 --- a/.buildkite/deployment.yml +++ b/.buildkite/deployment.yml @@ -26,7 +26,7 @@ steps: command: ".buildkite/steps/aurpackages.sh | buildkite-agent pipeline upload" if: build.tag != null || build.branch == "master" - - label: ":docs: Deploy documentation" + - label: ":book: Deploy Documentation" command: "syncdoc.sh" agents: upload: "fast" diff --git a/.buildkite/steps/syncdoc.sh b/.buildkite/steps/syncdoc.sh index 3a13c7fa2..6c4bd08e3 100755 --- a/.buildkite/steps/syncdoc.sh +++ b/.buildkite/steps/syncdoc.sh @@ -3,7 +3,7 @@ set -e rm -rf authelia -git clone git@github.com:authelia/authelia.git --branch gh-pages +git clone git@github.com:authelia/authelia.git --single-branch --branch gh-pages pushd docs bundle install @@ -14,7 +14,7 @@ COMMIT=$(git show -s --format=%h) pushd authelia git add -A -git commit -m "synchronize docs of commit ${COMMIT}" +git commit -m "Synchronize docs of commit: ${COMMIT}" git push popd diff --git a/docs/Gemfile b/docs/Gemfile index bb490aa87..00468b264 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -8,7 +8,7 @@ source "https://rubygems.org" # # This will help ensure the proper Jekyll version is running. # Happy Jekylling! -# gem "jekyll", "~> 3.8.5" +gem "jekyll", "~> 3.8.5" # This is the default theme for new Jekyll sites. You may change this to anything you like. #gem "minima", "~> 2.0" diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 67cad73ec..3863b0380 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -248,6 +248,7 @@ PLATFORMS DEPENDENCIES github-pages + jekyll (~> 3.8.5) just-the-docs tzinfo-data diff --git a/docs/configuration/authentication/file.md b/docs/configuration/authentication/file.md index c75c887a4..af1be4845 100644 --- a/docs/configuration/authentication/file.md +++ b/docs/configuration/authentication/file.md @@ -63,7 +63,7 @@ For instance, with the docker image, just run $6$rounds=50000$BpLnfgDsc2WD8F2q$be7OyobnQ8K09dyDiGjY.cULh4yDePMh6CUMpLwF4WHTJmLcPE2ijM2ZsqZL.hVAANojEfDu3sU9u9uD7AeBJ/ -## Password Hash Function +## Password Hash Function The only supported hash function is salted sha512 determined by the prefix `$6$` as described in this [wiki](https://en.wikipedia.org/wiki/Crypt_(C)) page. @@ -74,4 +74,3 @@ The best algorithm, [Argon2](https://en.wikipedia.org/wiki/Argon2) does though. [Password Hashing Competition](https://en.wikipedia.org/wiki/Password_Hashing_Competition) in 2015 and is now considered the best hashing function. There is an open [issue](https://github.com/authelia/authelia/issues/577) to add support for this hashing function. - diff --git a/docs/configuration/notifier/smtp.md b/docs/configuration/notifier/smtp.md index e44086520..01c6f8f72 100644 --- a/docs/configuration/notifier/smtp.md +++ b/docs/configuration/notifier/smtp.md @@ -36,7 +36,7 @@ notifier: ## trusted_cert: "" ``` -## Using Gmail +## Using Gmail You need to generate an app password in order to use Gmail SMTP servers. The process is described [here](https://support.google.com/accounts/answer/185833?hl=en) diff --git a/docs/configuration/regulation.md b/docs/configuration/regulation.md index 26d8fc0a4..51174a758 100644 --- a/docs/configuration/regulation.md +++ b/docs/configuration/regulation.md @@ -10,7 +10,7 @@ nav_order: 7 **Authelia** can temporarily ban accounts when there was too many authentication attempts. This helps prevent brute force attacks. -## Configuration +## Configuration ```yaml regulation: diff --git a/docs/configuration/storage/sqlite.md b/docs/configuration/storage/sqlite.md index cc961bbf5..ebb37d335 100644 --- a/docs/configuration/storage/sqlite.md +++ b/docs/configuration/storage/sqlite.md @@ -12,7 +12,7 @@ If you don't have a SQL server, you can use [SQLite](https://en.wikipedia.org/wi However please note that this setup will prevent you from running multiple instances of Authelia since the database will be a local file. -## Configuration +## Configuration Just give the path to the sqlite database. It will be created if the file does not exist. diff --git a/docs/getting-started.md b/docs/getting-started.md index 18f3d8a48..d2aeaeeac 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -34,7 +34,7 @@ normal to see this exception several times. Below is what the login page looks like after you accepted all exceptions:

- +

You can use one of the users listed in diff --git a/docs/index.md b/docs/index.md index 89f5148ed..9b904fc8b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -42,22 +42,12 @@ so that you can test it in minutes. Let's begin with the * is not an OAuth or OpenID Connect provider yet. * is not a SAML provider yet. -<<<<<<< HEAD -* does not support support authentication against an OAuth or OpenID Connect provider. -* does not support using hardware devices as single factor. -* does not allow provide a PAM module yet. -======= * does not support authentication against an OAuth or OpenID Connect provider. * does not support authentication against a SAML provider. * does not support using hardware devices as single factor. * does not provide a PAM module yet. ->>>>>>> [WIP] Use 'Just-the-docs' jekyll theme to organize documentation. [Duo]: https://duo.com/ [Yubikey]: https://www.yubico.com/products/yubikey-hardware/yubikey4/ -<<<<<<< HEAD [Google Authenticator]: https://google-authenticator.com/ -======= -[Google Authenticator]: https://google-authenticator.com/ ->>>>>>> [WIP] Use 'Just-the-docs' jekyll theme to organize documentation.