cclohmar/authelia-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update README for policy management, Docker image rename, and corrected repo URLs

Browse source
This commit is contained in:
Claus Lohmar 2026-07-15 18:01:44 +00:00
parent 92f0e7ea25
commit 35bc7566ea
1 changed files with 15 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,21 +1,23 @@
# Authelia API
A Go-based REST API and management layer that sits alongside an Authelia LXC on Proxmox. Provides a "Source of Truth" in SQLite, handles bulk user onboarding via JSON, and automates synchronization of the Authelia `users_database.yml` file.
A Go-based REST API and management layer that sits alongside an Authelia instance. Provides a "Source of Truth" in SQLite, handles bulk user onboarding via JSON, manages access control policies dynamically, and automates synchronization of the Authelia `users_database.yml` file.
## Features
- **Sovereign Bootstrap**: Automatically imports existing Authelia users on first run
- **Bulk User Management**: Create multiple users via JSON API with automatic password generation
- **Policy Management**: Full CRUD for access control policies with dry-run verification
- **Real-time Sync**: SQLite changes automatically sync to Authelia's YAML configuration
- **SMTP Onboarding**: Send welcome emails using Authelia's SMTP configuration
- **Secure API**: Bearer token authentication with bcrypt hashing
- **Drop-in Deployment**: Runs alongside existing Authelia installation
- **OpenAPI 3.0 Spec**: Complete API specification at [`openapi.yml`](openapi.yml)
## Installation
### Docker Deployment (Recommended)
A combined container with **both Authelia and Authelia-API** is available on Docker Hub:
A combined container with **both Authelia and Authelia-API** is available on Docker Hub as [`git24hcom/authelia-api`](https://hub.docker.com/r/git24hcom/authelia-api):
```bash
# Create config directory with your Authelia configuration
@ -46,15 +48,15 @@ curl -H "Authorization: Bearer your-session-secret-value" http://localhost:8080/
Runs the install script directly on the host alongside an existing Authelia installation:
```bash
curl -fsSL https://git.lohmar.co.uk/cclohmar/autehlia-api/raw/branch/main/install-authelia-api.sh | sudo bash
curl -fsSL https://git.lohmar.co.uk/cclohmar/authelia-api/raw/branch/main/install-authelia-api.sh | sudo bash
```
### Manual Installation
1. **Download the binary**:
1. **Clone the repository**:
```bash
curl -fsSL -o authelia-api https://git.lohmar.co.uk/cclohmar/autehlia-api/raw/branch/main/authelia-api
chmod +x authelia-api
git clone https://git.lohmar.co.uk/cclohmar/authelia-api.git
cd authelia-api
```
2. **Run the installer**:
@ -97,19 +99,19 @@ See [POSTMAN_GUIDE.md](POSTMAN_GUIDE.md) for detailed setup and usage instructio
## Files in This Repository
- `authelia-api` - Ready-to-use binary (production)
- `install-authelia-api.sh` - Installation script
- `Dockerfile` - Combined Authelia + Authelia-API container image
- `Dockerfile` - 3-stage build: Authelia download → Go build → runtime image
- `docker-compose.yml` - Quick Docker deployment with volumes
- `docker/` - Container entrypoint and configuration templates
- `POSTMAN_GUIDE.md` - API testing guide
- `src/` - Source code and build instructions
- `authelia-api.postman_collection.json` - Postman collection
- `src/` - Go source code (cmd/server, internal packages, migrations)
- `openapi.yml` - OpenAPI 3.0.3 specification for all endpoints
- `install-authelia-api.sh` - Bare-metal installation script
- `POSTMAN_GUIDE.md` - API testing guide with examples
- `authelia-api.postman_collection.json` - Postman collection (12 endpoints)
- `authelia-api.postman_environment.json` - Postman environment
## Mirror
This project is developed on [git.lohmar.co.uk](https://git.lohmar.co.uk/cclohmar/autehlia-api) and mirrored to [Codeberg](https://codeberg.org/cclohmar/autehlia-api).
This project is developed on [git.lohmar.co.uk](https://git.lohmar.co.uk/cclohmar/authelia-api) and mirrored to [Codeberg](https://codeberg.org/cclohmar/authelia-api).
## License