Quick Start

Get coreX Manager running in minutes with Docker Compose. This guide covers deployment, first login, and your first config apply.

Prerequisites

  • A Linux host with Docker and the Docker Compose plugin installed
  • Ports 80, 443, 3000, 8000, and 8404 available (configurable)

1. Clone the Repository

git clone https://github.com/ne4u/corex_manager.git
cd corex_manager

2. Configure Environment

Copy the example environment file and edit it:

cp .env.example .env

Key settings to review:

VariableDefaultDescription
ADMIN_PASSWORD(random)Admin user password. Set this for production.
SECRET_KEY(random)JWT signing key. Set this for production.
HAPROXY_MAXCONN100000Max HAProxy connections. Lower if memory is limited.
CORAZA_SPOA_ENABLEDtrueEnable the Coraza WAF SPOA.

3. Start the Stack

docker compose up -d --build

This starts five services:

ServicePortDescription
frontend3000React web GUI
api8000FastAPI control plane
corex80, 443HAProxy data plane
coraza-spoaCoraza WAF SPOA
valkeyIn-memory store (caching, rate limits, tokens)

4. Log In

Open your browser to http://<host>:3000 and log in with:

  • Username: admin
  • Password: the value of ADMIN_PASSWORD from your .env file (or admin if unset)
Change the default password

For production deployments, always set ADMIN_PASSWORD in your .env file before starting the stack. If left unset, a random password is generated and printed in the API logs.

5. Add a Listener

  1. Navigate to Configuration > Listeners
  2. Click Add Listener
  3. Enter a name (e.g. web-frontend)
  4. Set bind address to 0.0.0.0 and port to 80
  5. Select protocol http
  6. Click Save

6. Add a Backend

  1. Navigate to Configuration > Backends
  2. Click Add Backend
  3. Enter a name (e.g. web-servers)
  4. Select protocol http
  5. Select algorithm roundrobin
  6. Click Save
  7. Click Servers on the backend row
  8. Add a server: name web1, address 127.0.0.1, port 8080
  9. Click Save

7. Apply Configuration

  1. Navigate to the Dashboard (home page)
  2. Click Preview to see the generated HAProxy config
  3. Review the config, then click Apply Config
  4. Watch the task toast in the bottom-right corner for progress
  5. Once applied, HAProxy is live and routing traffic
Config snapshots

Every Apply Config creates a config snapshot. You can revert to any previous snapshot from Management > Snapshots.

Service URLs

After deployment, the services are available at:

ServiceURL
Web GUIhttp://<host>:3000
APIhttp://<host>:8000
HAProxyhttp://<host>:80 / https://<host>:443
HAProxy Statshttp://<host>:8404

Next Steps