Development

Guide for contributors and developers working on Zentinel and its ecosystem.

Quick Start

# Clone and build
git clone https://github.com/zentinelproxy/zentinel.git
cd zentinel
cargo build --release

# Run tests
cargo test

# Check formatting and lints
cargo fmt --check
cargo clippy

Section Overview

Guide	Description
Building from Source	Compile Zentinel and agents from source
Development Setup	IDE configuration, recommended tools
Code Style	Formatting, naming conventions, best practices
Testing	Testing strategy and philosophy
Unit Tests	Writing and running unit tests
Integration Tests	End-to-end testing with real connections
Load Testing	Performance and stress testing
Contributing	How to contribute to the project
Pull Request Process	Submitting and reviewing PRs
Release Process	Versioning and release workflow

Repository Structure

zentinel/
├── src/
│   ├── main.rs              # Entry point
│   ├── config/              # KDL configuration parsing
│   ├── server/              # HTTP server, listeners
│   ├── routing/             # Route matching, upstream selection
│   ├── proxy/               # Request/response proxying
│   ├── agents/              # Agent client, protocol handling
│   ├── health/              # Health checks
│   └── observability/       # Metrics, logging, tracing
├── tests/
│   ├── unit/                # Unit tests
│   └── integration/         # Integration tests
├── benches/                 # Benchmarks
└── examples/                # Example configurations

Agent Repositories

Each agent is maintained in its own repository:

Agent	Repository
WAF	zentinel-agent-waf
ModSecurity	zentinel-agent-modsec
Auth	zentinel-agent-auth
Rate Limit	zentinel-agent-ratelimit
JavaScript	zentinel-agent-js
AI Gateway	zentinel-agent-ai-gateway
WebSocket Inspector	zentinel-agent-websocket-inspector

Agent Protocol

All agents use the shared protocol library:

[dependencies]
zentinel-agent-protocol = "0.1"

See Agent Development for creating custom agents.