Installation

note

This guide is for self-hosted KoreShield deployments. Hosted customers can skip installation and proceed with the API integration.

Prerequisites

• Docker + Docker Compose
• A KoreShield deployment bundle provided by the KoreShield team
• Environment values for JWT and provider keys

Get the Deployment Bundle

Your account team will provide a deployment bundle and environment variables. This avoids needing access to the private core repository.

Configure

Apply the JWT, database, Redis, and provider values provided by KoreShield.

Run

Start the container stack included with your deployment bundle.

Verify

curl http://localhost:8000/health
curl http://localhost:8000/openapi.json | head

Next Steps

• Client Integration Guide
• REST API
• Integrations