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

54 lines
1.8 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)
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
which is available after running `source bootstrap.sh`. This CLI provides many useful tools to help you during
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
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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
In order to build and contribute to **Authelia**, you need to make sure Go v1.13, Docker,
docker-compose and Node with version >= 8 and < 12 are 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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
## Get started
[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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
**Authelia** is made of Go application serving the API and a [React](https://reactjs.org/)
application for the portal.
[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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
In order to ease development, Authelia uses the concept of [suites] to run Authelia from source
code so that your patches are included. This is a kind of virtual environment running **Authelia**
in a complete ecosystem (LDAP, Redis, SQL server). Note that Authelia is hotreloaded in the
environment so that your patches are instantly included.
[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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
The next command starts the suite called *Standalone*:
[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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
authelia-scripts suites setup Standalone
[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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
Most of the suites are using docker-compose to bootstrap the environment. Therefore, you
can check the logs of all application by running the following command on the component
you want to monitor.
[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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
docker logs authelia_authelia-backend_1 -f
[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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
Then, edit the code and observe how **Authelia** is automatically reloaded.
[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
### Unit tests
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
To run the unit tests, 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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
Integration tests are located under the `suites` directory based on Selenium.
[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 test
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
You don't need to start the suite before testing it. Given you're not running
any suite, just use the following command to test the *Standalone* suite.
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
Cleanup documentation. Remove mention of Mongo and basic suites. Also adapt some part to changes made to authelia-scripts.
2019-11-16 14:43:20 +00:00
authelia-scripts suites test Standalone
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 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