authelia/docs/content/en/contributing/development/reference-authelia-scripts.md

1.5 KiB

title description lead date draft images menu weight toc aliases
Reference: authelia-scripts This section covers the authelia-scripts tool. This section covers the authelia-scripts tool. 2022-05-15T13:52:27+10:00 false
contributing
parent
development
290 true
/docs/contributing/authelia-scripts.html

Authelia comes with a set of dedicated scripts to perform a broad range of operations such as building the distributed version of Authelia, building the Docker image, running suites, testing the code, etc. This is a small reference guide for the command, the full guide can be found in the CLI Reference.

Examples

Those scripts become available after sourcing the bootstrap.sh script with:

source bootstrap.sh

Then, you can access the scripts usage by running the following command:

authelia-scripts --help

For instance, you can build Authelia ([go] binary and [React] frontend) with:

authelia-scripts build

Or build the official [Docker] image with:

authelia-scripts docker build

Or start the Standalone suite with:

authelia-scripts suites setup Standalone

Help

The authelia-scripts provides help using the --help or -h flags. Every command should provide some form of help when provided with either flag. Examples:

authelia-scripts --help
authelia-scripts build --help