Squawk DNS, a Penguin Technologies Solution

Documentation

Comprehensive guides, API references, and tutorials to help you deploy and manage Squawk DNS successfully.

Quick Access

Jump directly to what you need

Documentation Sections

Comprehensive guides organized by topic

Getting Started

Everything you need to deploy Squawk DNS in your environment.

Architecture & Security

Deep dive into Squawk DNS architecture and security features.

API & Development

API documentation and development resources for integration.

Enterprise & Support

Enterprise deployment guides and support resources.

Code Examples

Quick examples to get you started

Docker Compose (Local Testing)
# Complete local testing environment git clone https://github.com/penguincloud/squawk.git cd Squawk # Set environment variables export AUTH_TOKEN=your-secure-token export POSTGRES_PASSWORD=secure-password # Start full stack (DNS server + client + cache) docker-compose up -d # Or start with PostgreSQL and monitoring docker-compose --profile postgres --profile monitoring up -d
Configuration Example
# Environment Variables export PORT=8080 export AUTH_TOKEN=secure-random-token export CACHE_ENABLED=true export CACHE_TTL=300 export ENABLE_BLACKLIST=true export LOG_LEVEL=INFO # Start server with custom config ./squawk-dns-server --config config.yaml

Need Additional Help?

Multiple support channels available based on your needs

Community Support

Free community support via GitHub issues and discussions.

GitHub Issues

Documentation Site

Comprehensive documentation with search and examples.

Browse Docs

Enterprise Support

Priority support with SLA guarantees for enterprise customers.

Contact Sales

Ready to Get Started?

Choose your deployment method and start securing your DNS infrastructure today.