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

Restructure README: Docker first, bare metal collapsed, remove obsolete Production Deployment section

Browse source
This commit is contained in:
root 2026-06-24 19:05:46 +00:00
parent 48d083c355
commit 5859de5fdf
1 changed files with 22 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -13,29 +13,7 @@ A Go-based REST API and management layer that sits alongside an Authelia LXC on
## Installation ## Installation
### Quick Installation (Recommended) ### Docker Deployment (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
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:
@ -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. **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 ### Development Installation
For building from source, see the [src/README.md](src/README.md) file. 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_collection.json` - Postman collection
- `authelia-api.postman_environment.json` - Postman environment - `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 ## License
MIT License MIT License