doorman/user-docs

Doorman API Gateway - Documentation

Welcome to the Doorman API Gateway documentation. This guide will help you set up, configure, secure, and operate your API gateway.

Documentation Index

1. Getting Started

Start here - Installation, quick start, and your first API setup

• Local development setup
• Docker Compose deployment
• First admin login
• Creating your first API

2. Configuration Reference

Complete guide to environment variables and configuration options

• Environment variables explained
• Cache and database modes (Memory, Redis, MongoDB)
• HTTPS and TLS configuration
• CORS and security settings

3. Security Guide

Comprehensive security features and best practices

• HTTPS enforcement and TLS
• Authentication and JWT tokens
• CSRF protection
• IP access control and whitelisting
• Request validation and limits
• Audit logging and monitoring

4. API Workflows

Real-world examples and end-to-end workflows

• Publishing REST APIs with API key injection
• Client-specific routing
• Per-user token management
• GraphQL gateway setup
• SOAP API configuration
• Common errors and troubleshooting

5. Operations Guide

Production deployment, monitoring, and runbooks

• Production deployment checklist
• Health checks and monitoring endpoints
• Redis and MongoDB setup
• Graceful restarts and memory dumps
• Runbooks for common issues
• Response envelope configuration

6. Tools and Diagnostics

Built-in tools for troubleshooting and validation

• CORS checker tool
• Diagnostic endpoints
• Log analysis

---

Quick Links

• Main README: ../README.md
• GitHub Repository: https://github.com/apidoorman/doorman
• License: Apache 2.0

Need Help?

• Check the API Workflows for common use cases
• Review the Operations Guide for production issues
• Use the CORS Checker to diagnose CORS problems
• Consult the Security Guide for hardening best practices