Citadel Quick Start

This guide gets you up and running with a fully local instance of the Citadel platform in minutes, using Docker Compose.

Note: This setup is intended for showcase and evaluation purposes. For development, please refer to the Local Development Setup.

Prerequisites

• Docker Desktop (or Docker Engine + Compose) installed.
• git installed.

1. Start the Platform

1. Clone the repository:

   git clone https://gitlab.com/castlecraft/citadel.git
   cd citadel

2. Run Production Stack: The docker-compose.yml in the root is pre-configured for a production-like environment with real images and services.

   docker-compose up -d

   First run may take a few minutes to download images and initialize databases.

2. Verify Installation

Once all containers are running (check via docker ps or Docker Desktop dashboard):

1. Open the Shell Application: Navigate to http://localhost:5000.

2. Log In: You will be redirected to the Keycloak login page.

   • Username: admin
   • Password: admin

3. Explore: After login, you will land on the Admin Portal dashboard.

3. Services Overview

The Quick Start spins up the following key services:

Service	Local URL	Credentials
Shell App	http://localhost:5000	-
API Gateway (Traefik)	http://localhost:80	-
Keycloak	http://localhost:8080/keycloak	admin / admin
Mailpit (Email)	http://localhost:8025	-
Temporal UI	http://localhost:8233	-
Traefik Dashboard	http://localhost:8081/dashboard/	-

Stopping

To stop the platform and remove containers:

docker-compose down

To stop and remove volumes (reset data):

docker-compose down -v