cdk8s-mailu Documentation

CDK8S Construct Library for Mailu Mail Server Deployment

Welcome to the cdk8s-mailu documentation. This documentation covers everything from initial setup to advanced configuration and architectural concepts for deploying Mailu mail servers using CDK8S.

About cdk8s-mailu

cdk8s-mailu is a TypeScript construct library for CDK8S that enables programmatic deployment of Mailu mail servers on Kubernetes. It provides type-safe, reusable constructs for all Mailu components with production-grade defaults.

Key Features:

• Type-safe TypeScript constructs for all Mailu components

• Production-grade defaults with full customization

• Integration with PostgreSQL and Redis

• Support for Traefik TLS termination

• Comprehensive resource management (CPU, memory, storage)

• Component-level enable/disable toggles

• Test coverage >90%

Documentation Structure

This documentation follows the Diátaxis framework, organizing content into four categories based on what you need:

Tutorials

Learning-oriented: Step-by-step lessons to build skills

Start here if you’re new to cdk8s-mailu

Tutorials

How-To Guides

Goal-oriented: Solutions to specific problems

Use these when you need to accomplish something

How-To Guides

Reference

Information-oriented: Technical specifications and configurations

Consult when you need detailed information

Reference

Explanation

Understanding-oriented: Concepts and design decisions

Read to deepen your understanding

Explanation

Quick Links

Getting Started

• Setup Prerequisites - Prepare cluster infrastructure

• Setup PostgreSQL - Deploy database (Bitnami or CNPG)

• Setup Redis - Deploy cache

• Quick Start - Deploy your first Mailu instance

Common Tasks

• Manage Secrets - Create Kubernetes secrets for Mailu

• Scale Resources - Adjust CPU and memory limits

• Customize Storage - Configure PVC sizes and storage classes

• Enable Optional Components - Add ClamAV, Webdav, Fetchmail

• Configure TLS - Set up Traefik TLS termination

• Upgrade Mailu - Upgrade to newer versions

• Backup and Restore - Protect your mail data

Architecture

• Architecture Overview - High-level design with flows

• Authentication Flows - How authentication works

• Nginx Configuration Patches - TLS termination implementation

• Storage Architecture - Persistent storage sizing

• Dovecot Submission Service - Webmail email sending

• Component Specifications - Technical specifications

• Configuration Options - Complete API reference

Table of Contents

Documentation

• Tutorials
  • Quick Start: Deploy Your First Mailu Instance
• How-To Guides
  • Setup Prerequisites
  • Setup PostgreSQL Database
  • Setup Redis
  • Configure Constructs
  • Scale Resources
  • Customize Storage
  • Enable Optional Components
  • Configure TLS Termination
  • Manage Secrets
  • Upgrade Mailu Version
  • Backup and Restore
• Reference
  • Configuration Options
  • Component Specifications
• Explanation
  • Architecture Overview
  • Authentication Flows
  • Nginx Configuration Patches
  • Storage Architecture
  • Dovecot Submission Service
  • Egress Gateway Considerations for Mail Delivery
  • CDK8S Patterns

---

Last updated: 2025-01-15 cdk8s-mailu version: 0.0.0 CDK8S version: ^2.70.26