init: Initial commit
This commit is contained in:
45
.docs/index.md
Normal file
45
.docs/index.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# SecNex API Gateway Documentation
|
||||
|
||||
Welcome to the official documentation for the SecNex API Gateway.
|
||||
|
||||
## Overview
|
||||
|
||||
SecNex API Gateway is a high-performance, configurable API gateway built in Go. It provides reverse proxy capabilities with built-in security features including authentication and web application firewall (WAF) functionality.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Run locally
|
||||
cd app
|
||||
go run main.go
|
||||
|
||||
# Run with Docker
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Architecture](./architecture.md) - System architecture and component design
|
||||
- [Configuration](./configuration.md) - Configuration reference and examples
|
||||
- [Usage](./usage.md) - How to use the gateway
|
||||
- [Development](./development.md) - Development setup and guide
|
||||
- [Deployment](./deployment.md) - Deployment instructions
|
||||
|
||||
## Features
|
||||
|
||||
- **Reverse Proxy** Route requests to backend services
|
||||
- **Authentication** Header-based authentication (API key, session tokens)
|
||||
- **WAF** Web Application Firewall with method filtering and IP-based access control
|
||||
- **Path-based Routing** Configurable route patterns with prefix stripping
|
||||
- **Middleware Pipeline** Extensible middleware chain for custom logic
|
||||
- **Logging** Structured logging with sensitive field pseudonymization
|
||||
|
||||
## Health Check
|
||||
|
||||
The gateway provides a health check endpoint:
|
||||
|
||||
```
|
||||
GET /_/health
|
||||
```
|
||||
|
||||
Returns `200 OK` when the gateway is running.
|
||||
Reference in New Issue
Block a user