# local-docker-deployment Specification

## ADDED Requirements

### Requirement: Docker deployment files

The repository SHALL provide a local Docker deployment that starts the platform backend, run worker, and platform web console.

#### Scenario: Compose starts local services with persistent directories

- **GIVEN** an operator runs the local compose file
- **WHEN** the services start
- **THEN** the platform SHALL use a durable mounted data directory
- **AND** the run worker SHALL use a mounted workspace/spool directory
- **AND** the web console SHALL proxy platform API calls through platform-owned routes.

### Requirement: Local debugging configuration examples

The repository SHALL document direct local execution configuration through example environment files.

#### Scenario: Developer wants to change ports or storage paths

- **GIVEN** a developer wants to run the platform, run worker, and web console directly
- **WHEN** they inspect the environment examples
- **THEN** they SHALL find the platform listen address, storage backend, metadata path, log directory, run platform URL, run workspace/spool roots, and web API/proxy settings.

### Requirement: Storage guidance remains scoped

The deployment documentation SHALL distinguish metadata storage from log body storage.

#### Scenario: Operator asks where large server logs should go

- **GIVEN** a deployment with hundreds or thousands of servers
- **WHEN** the operator reads the deployment guidance
- **THEN** it SHALL say relational databases are for metadata and indexes
- **AND** it SHALL recommend log-optimized backends for high-volume log bodies in future adapters.