authelia/docs/contributing/authelia-scripts.md
James Elliott 08e674b62f
docs: refactor several areas of documentation (#1726)
Updated all links to use https://www.authelia.com/docs/.
Removed all comment sections from documented configuration on the documentation site and replaced them with their own sections.
Made all documentation inside config.template.yml double hashes, and made all commented configuration sections single quoted.
Added .yamllint.yaml to express our desired YAML styles.
Added a style guide.
Refactored many documentation areas to be 120 char widths where possible. It's by no means exhaustive but is a large start.
Added a statelessness guide for the pending Kubernetes chart introduction.
Added labels to configuration documentation and made many areas uniform.
2021-04-11 21:25:03 +10:00

45 lines
907 B
Markdown

---
layout: default
title: Authelia Scripts
parent: Contributing
nav_order: 2
---
# Authelia Scripts
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...
Those scripts become available after sourcing the bootstrap.sh script with
```console
$ source bootstrap.sh
```
Then, you can access the scripts usage by running the following command:
```console
$ authelia-scripts --help
```
For instance, you can build Authelia (Go binary and frontend) with:
```console
$ authelia-scripts build
```
Or build the official Docker image with:
```console
$ authelia-scripts docker build
```
Or start the *Standalone* suite with:
```console
$ authelia-scripts suites setup Standalone
```
You will find more information in the scripts usage helpers.