authelia/docs/contributing/authelia-scripts.md
Amir Zarrinkafsh e091032279
docs: update contribution guidelines (#1666)
* docs: update contribution guidelines

* add release commit message type

* update none/empty scope definition

* add go mod tidy post update option
2021-01-30 19:29:07 +11:00

34 lines
841 B
Markdown

---
layout: default
title: Authelia Scripts
parent: Contributing
nav_order: 2
---
# Authelia Scripts
Authelia comes with a set of dedicated scripts doing 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 becomes 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 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
You will find more information in the scripts usage helpers.