authelia/docs/authelia-scripts.md

# 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 with:

    authelia-scripts build

Or start the *docker-image* suite with:

    authelia-scripts suites start docker-image

You will find more information in the scripts usage helpers.
Update the documentation to include info about suites and authelia-scripts. 2019-03-02 23:25:40 +00:00			`# 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...`

[BREAKING] Create a suite for kubernetes tests. Authelia client uses hash router instead of browser router in order to work with Kubernetes nginx-ingress-controller. This is also better for users having old browsers. This commit is breaking because it requires to change the configuration of the proxy to include the # in the URL of the login portal. 2019-03-03 22:51:52 +00:00			`Those scripts becomes available after sourcing the bootstrap.sh script with`
Update the documentation to include info about suites and authelia-scripts. 2019-03-02 23:25:40 +00:00
[BREAKING] Create a suite for kubernetes tests. Authelia client uses hash router instead of browser router in order to work with Kubernetes nginx-ingress-controller. This is also better for users having old browsers. This commit is breaking because it requires to change the configuration of the proxy to include the # in the URL of the login portal. 2019-03-03 22:51:52 +00:00			`source bootstrap.sh`

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

			`authelia-scripts --help`
Update the documentation to include info about suites and authelia-scripts. 2019-03-02 23:25:40 +00:00
			`For instance, you can build Authelia with:`

[BREAKING] Create a suite for kubernetes tests. Authelia client uses hash router instead of browser router in order to work with Kubernetes nginx-ingress-controller. This is also better for users having old browsers. This commit is breaking because it requires to change the configuration of the proxy to include the # in the URL of the login portal. 2019-03-03 22:51:52 +00:00			`authelia-scripts build`
Update the documentation to include info about suites and authelia-scripts. 2019-03-02 23:25:40 +00:00
Create suite for testing the docker image. Running this suite is the first advice given by the bootstrap script to help the user move forward. This commit also updates the documentation to reflect changes introduced by the Go rewrite. 2019-11-03 12:07:02 +00:00			`Or start the docker-image suite with:`
Update the documentation to include info about suites and authelia-scripts. 2019-03-02 23:25:40 +00:00
Create suite for testing the docker image. Running this suite is the first advice given by the bootstrap script to help the user move forward. This commit also updates the documentation to reflect changes introduced by the Go rewrite. 2019-11-03 12:07:02 +00:00			`authelia-scripts suites start docker-image`
Update the documentation to include info about suites and authelia-scripts. 2019-03-02 23:25:40 +00:00
			`You will find more information in the scripts usage helpers.`