authelia

(★ 28,642)

The Single Sign-On Multi-Factor portal for web apps, now OpenID Certified™

Showing a partial file list — download the zip above to see everything.

  • .all-contributorsrc
  • .codecov.yml
  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .golangci.yml
  • .goreleaser.yml
  • .grype.yaml
  • .healthcheck.env
  • .lefthook.yml
  • .mailmap
  • .renovaterc
  • .reviewdog.yml
  • .shellcheckrc
  • .trufflehog
  • .typos.toml
  • .yamllint.yml
  • authelia-fb-rc.d
  • authelia.service
  • authelia.sysusers.conf
  • authelia.tmpfiles.conf
  • authelia.tmpfiles.config.conf
  • authelia@.service
  • bootstrap.sh
  • CITATION.cff
  • CODE_OF_CONDUCT.md
  • config.template.yml
  • CONTRIBUTING.md
  • crowdin.yml
  • Dockerfile
  • Dockerfile.coverage
  • Dockerfile.coverage.dockerignore
  • Dockerfile.dev
  • Dockerfile.dev.dockerignore
  • entrypoint.sh
  • go.mod
  • go.sum
  • healthcheck.sh
  • LICENSE
  • README.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/authelia/authelia

Downloads the entire project code from GitHub to your computer.

cd authelia

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f internal/suites/ActiveDirectory/compose.yml up -d --build

Runs the command against the services defined in the compose file.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd web

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

If the build finishes without errors, it worked. If you used go run ., check the terminal output.
// repository documentation