authelia/docs/content/en/configuration/miscellaneous/guides.md
James Elliott b2c60ef898
feat: major documentation refresh (#3475)
This marks the launch of the new documentation website.
2022-06-15 17:51:47 +10:00

2.2 KiB

title description lead date draft images menu weight toc
Guides Miscellaneous Guides for Configuration. This section contains miscellaneous guides used in the configuration. 2022-05-16T15:21:22+10:00 false
configuration
parent
miscellaneous
199500 true

Generating a Random Alphanumeric String

Some sections of the configuration recommend generating a random string. There are many ways to accomplish this, one possible way on Linux is utilizing the following command which prints a string with a length in characters of ${LENGTH} to stdout. The string will only contain alphanumeric characters.

LENGTH=64
tr -cd '[:alnum:]' < /dev/urandom | fold -w "${LENGTH}" | head -n 1 | tr -d '\n' ; echo

Generating an RSA Keypair

Some sections of the configuration need an RSA keypair. There are many ways to achieve this, this section explains two such ways.

openssl

The openssl command on Linux can be used to generate a RSA 4096 bit keypair:

openssl genrsa -out private.pem 4096
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

authelia

The Authelia docker container or CLI binary can be used to generate a RSA 4096 bit keypair:

docker run -u "$(id -u):$(id -g)" -v "$(pwd)":/keys authelia/authelia:latest authelia rsa generate --dir /keys
authelia rsa generate --dir /path/to/keys

Generating an RSA Self-Signed Certificate

Some sections of the configuration need a certificate and it may be possible to use a self-signed certificate. There are many ways to achieve this, this section explains two such ways.

openssl

The openssl command on Linux can be used to generate a RSA 4096 bit self-signed certificate for the domain example.com:

openssl req -x509 -nodes -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 365 -subj '/CN=example.com'

authelia

The Authelia docker container or binary can be used to generate a RSA 4096 bit self-signed certificate for the domain example.com:

docker run -u "$(id -u):$(id -g)" -v "$(pwd)":/keys authelia/authelia authelia certificates generate --host example.com --dir /keys
authelia certificates generate --host example.com --dir /path/to/keys