From 5859de5fdf392a490699718afdc57e1588858a60 Mon Sep 17 00:00:00 2001 From: root Date: Wed, 24 Jun 2026 19:05:46 +0000 Subject: [PATCH] Restructure README: Docker first, bare metal collapsed, remove obsolete Production Deployment section --- README.md | 56 ++++++++++++++++++++++--------------------------------- 1 file changed, 22 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 6266e6c..f0445be 100644 --- a/README.md +++ b/README.md @@ -13,29 +13,7 @@ A Go-based REST API and management layer that sits alongside an Authelia LXC on ## Installation -### Quick Installation (Recommended) - -Download and execute the installation script: - -```bash -curl -fsSL https://git.lohmar.co.uk/cclohmar/autehlia-api/raw/branch/main/install-authelia-api.sh | sudo bash -``` - -### Manual Installation - -1. **Download the binary**: - ```bash - # Download the latest authelia-api binary - curl -fsSL -o authelia-api https://git.lohmar.co.uk/cclohmar/autehlia-api/raw/branch/main/authelia-api - chmod +x authelia-api - ``` - -2. **Run the installer**: - ```bash - sudo ./install-authelia-api.sh - ``` - -### Docker Deployment +### Docker Deployment (Recommended) A combined container with **both Authelia and Authelia-API** is available on Docker Hub: @@ -63,6 +41,27 @@ curl -H "Authorization: Bearer your-session-secret-value" http://localhost:8080/ **Authelia configuration reference**: The example file at `docker/configuration.yml.example` covers the essentials, but Authelia has many more options. See the [official Authelia configuration docs](https://www.authelia.com/configuration/) for details on secrets, domains, authentication backends, and access control rules. +### Bare Metal (Quick Installation) + +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 +``` + +### Manual Installation + +1. **Download the binary**: + ```bash + curl -fsSL -o authelia-api https://git.lohmar.co.uk/cclohmar/autehlia-api/raw/branch/main/authelia-api + chmod +x authelia-api + ``` + +2. **Run the installer**: + ```bash + sudo ./install-authelia-api.sh + ``` + ### Development Installation For building from source, see the [src/README.md](src/README.md) file. @@ -107,17 +106,6 @@ See [POSTMAN_GUIDE.md](POSTMAN_GUIDE.md) for detailed instructions. - `authelia-api.postman_collection.json` - Postman collection - `authelia-api.postman_environment.json` - Postman environment -## Production Deployment - -**Docker** (recommended): Use `docker compose up -d` — see [Docker Deployment](#docker-deployment) above. - -**Bare-metal**: The repository also provides a ready-to-deploy binary. The installation script handles: -- Systemd service creation -- Database setup -- Configuration generation -- User creation -- Firewall configuration (if applicable) - ## License MIT License