authelia/docs/content/en/contributing/development/environment.md

title	description	lead	date	draft	images	menu	weight	toc
Environment	How to configure your development environment.	This section covers the environment we recommend for development.	2022-06-15T17:51:47+10:00	false		contributing parent development	220	true

Authelia and its development workflow can be tested with Docker and Docker Compose on Linux.

Setup

In order to build and contribute to Authelia, you need to make sure the following are installed in your environment:

• General:
  • git
• Backend Development:
  • go (v1.20 or greater)
  • gcc
• Frontend Development
  • Node.js (v18 or greater)
  • pnpm
• Integration Suites:
  • Docker
  • Docker Compose
  • chromium

The additional tools are recommended:

• golangci-lint
• goimports-reviser
• yamllint
• VSCodium or GoLand

Certificate

Authelia utilizes a self-signed Root CA certificate for the development environment. This allows us to sign elements of the CI process uniformly and only trust a single additional Root CA Certificate. The private key for this certificate is maintained by the [Core Team] so if you need an additional certificate signed for this purpose please reach out to them.

While developing for Authelia you may also want to trust this Root CA. It is critical that you are aware of what this means if you decide to do so.

1. It will allow us to generate trusted certificates for machines this is installed on.
2. If compromised there is no formal revocation process at this time as we are not a certified CA.
3. Trusting Root CA's is not necessary for the development process it only makes it smoother.
4. Trusting additional Root CA's for prolonged periods is not generally a good idea.

If you'd still like to trust the Root CA Certificate it's located (encoded as a PEM) in the main git repository at /internal/suites/common/pki/ca/ca.public.crt.

Scripts

There is a scripting context provided with Authelia which can easily be configured. It allows running integration suites and various other tasks. Read more about it in the authelia-scripts reference guide.

FAQ

Do you support development under Windows or OSX?

At the present time this is not officially supported. Some of the maintainers utilize Windows however running suites under Windows or OSX is not something that is currently possible to do easily. As such we recommend utilizing Linux.

What version of Docker and docker-compose should I use?

We have no firm recommendations on the version to use but we actively use the latest versions available to us in the distributions of our choice. As long as it's a modern version it should be sufficient for the development environment.

How can I serve my application under example.com?

Don't worry, you don't need to own the domain example.com to test Authelia. Copy the following lines in your /etc/hosts:

192.168.240.100 home.example.com
192.168.240.100 login.example.com
192.168.240.100 singlefactor.example.com
192.168.240.100 public.example.com
192.168.240.100 secure.example.com
192.168.240.100 mail.example.com
192.168.240.100 mx1.mail.example.com

The IP address 192.168.240.100 is the IP attributed by Docker to the reverse proxy. Once added you can access the listed subdomains from your browser, and they will be served by the reverse proxy.