RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
authelia/docs/build-and-dev.md

64 lines
2.1 KiB
Markdown
Raw Normal View History

[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
# Build and dev
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** is written in Go and comes with a dedicated CLI called [authelia-scripts](./authelia-scripts.md)
which is provided after running `source bootstrap.sh`. This CLI provides many useful tools to help you during
development.
[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
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
In order to build and contribute to **Authelia**, you need to make sure Node with version >= 8 and < 12,
Go v1.13 and Docker is installed on your machine.
[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
## Build
**Authelia** is made of two parts: the frontend and the backend.
The frontend is a [React](https://reactjs.org/) application written in Typescript and
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
the backend is Go application.
[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
The following command builds **Authelia** under dist/:
authelia-scripts build
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 you can also build the Alpine-based official Docker image 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 docker build
## Development
In order to ease development, Authelia uses the concept of [suites]. This is
a kind of virutal environment for **Authelia**, it allows you to run **Authelia** in a complete
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
ecosystem, develop and test your patches. A hot-reload feature has been implemented so that
you can test your changes right after the file has been saved.
[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
docs: fix urls
2019-08-27 16:36:40 +00:00
The next command will start the suite called [basic](../test/suites/basic/README.md):
[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 suites start basic
Then, edit the code and observe how **Authelia** is automatically updated.
### Unit tests
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
To run the unit tests written, run:
[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 unittest
### Integration tests
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
Integration tests run with Mocha and are based on Selenium. They generally
[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
require a complete environment made of several components like redis, mongo and a LDAP
to run. That's why [suites] have been created. At this point, the *basic* suite should
already be running and you can run the tests related to this suite with the following
command:
authelia-scripts suites test
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
You don't need to start the suite before testing it. Given your environment is not running
any suite, just use the following command to test the basic suite.
authelia-scripts suites test basic
The suite will be spawned, tests will be run and then the suite will be teared down
automatically.
[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
docs: fix urls
2019-08-27 16:36:40 +00:00
[suites]: ./suites.md