Update README.md for changes to script
All checks were successful
HAProxy Manager Build and Push / Build-and-Push (push) Successful in 39s
All checks were successful
HAProxy Manager Build and Push / Build-and-Push (push) Successful in 39s
This commit is contained in:
parent
c5f29374e1
commit
de2957fcd2
44
README.md
44
README.md
@ -1,11 +1,32 @@
|
||||
# HAProxy Manager Base
|
||||
# HAProxy Manager
|
||||
|
||||
A Flask-based API service for managing HAProxy configurations, domains, and SSL certificates.
|
||||
A Flask-based API service for managing HAProxy configurations with dynamic SSL certificate management and health monitoring.
|
||||
|
||||
To run the container:
|
||||
```bash
|
||||
docker run -d -p 80:80 -p 443:443 -p 8000:8000 -v lets-encrypt:/etc/letsencrypt -v haproxy:/etc/haproxy --name haproxy-manager repo.anhonesthost.net/cloud-hosting-platform/haproxy-manager-base:latest
|
||||
```
|
||||
## Features
|
||||
|
||||
- RESTful API for HAProxy configuration management
|
||||
- Database-backed configuration storage using SQLite
|
||||
- Automatic HAProxy configuration generation from templates
|
||||
- Let's Encrypt SSL certificate integration with auto-renewal
|
||||
- Health monitoring endpoint
|
||||
- Dynamic backend server management
|
||||
- Template override support for custom backend configurations
|
||||
- Process monitoring and auto-restart capabilities
|
||||
- Socket-based HAProxy runtime API integration
|
||||
|
||||
## Requirements
|
||||
|
||||
- HAProxy
|
||||
- Python 3.x
|
||||
- Flask
|
||||
- SQLite3
|
||||
- Certbot (for Let's Encrypt certificates)
|
||||
- OpenSSL (for self-signed start-up certificate)
|
||||
|
||||
## API Endpoints
|
||||
|
||||
@ -33,6 +54,7 @@ Content-Type: application/json
|
||||
{
|
||||
"domain": "example.com",
|
||||
"backend_name": "example_backend",
|
||||
"template_override": null,
|
||||
"servers": [
|
||||
{
|
||||
"name": "server1",
|
||||
@ -41,7 +63,7 @@ Content-Type: application/json
|
||||
"options": "check"
|
||||
},
|
||||
{
|
||||
"name": "server2",
|
||||
"name": "server2",
|
||||
"address": "10.0.0.2",
|
||||
"port": 8080,
|
||||
"options": "check backup"
|
||||
@ -90,21 +112,3 @@ Content-Type: application/json
|
||||
"message": "Domain configuration removed"
|
||||
}
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- Automatic HAProxy configuration generation
|
||||
- Let's Encrypt SSL certificate integration
|
||||
- Backend server management
|
||||
- Self-signed certificate generation for development
|
||||
- Health monitoring
|
||||
- Database-backed configuration storage
|
||||
|
||||
## Requirements
|
||||
|
||||
- HAProxy
|
||||
- Python 3.x
|
||||
- Flask
|
||||
- SQLite3
|
||||
- Certbot (for Let's Encrypt certificates)
|
||||
- OpenSSL (for self-signed certificates)
|
||||
|
Loading…
x
Reference in New Issue
Block a user