How-To Guides¶

How-to guides are practical, task-oriented instructions for solving specific problems. Unlike tutorials (which guide you through learning), these guides assume you're familiar with Nauyaca and focus on accomplishing particular tasks.

Looking to Learn?

If you're new to Nauyaca, start with the Tutorials section instead. How-to guides assume basic familiarity with the project.

Available Guides¶

Configure Server

Set up your Gemini server using TOML configuration files. Learn about all available options, defaults, and configuration patterns.

Configuration Guide
Manage Certificates

Generate and manage TLS certificates for your server. Create self-signed certificates for development or prepare for production deployment.

Certificate Management
Setup TOFU

Configure Trust-On-First-Use (TOFU) certificate validation for secure client connections. Import, export, and manage trusted hosts.

TOFU Setup
Rate Limiting

Protect your server from DoS attacks with token bucket rate limiting. Configure per-IP limits and customize behavior.

Rate Limiting Guide
Access Control

Implement IP-based access control with allow and deny lists. Use CIDR notation for network ranges and combine with rate limiting.

Access Control Guide
Client Certificates

Configure client certificate authentication for protected resources. Set up path-based certificate requirements and handle certificate validation.

Client Certificates Guide
Logging

Configure logging and monitoring for your Gemini server. Set log levels, customize formats, and track server activity.

Logging Guide
Hot-Reload

Enable automatic server restart during development when source files or content changes. Configure file watching and optimize your development workflow.

Hot-Reload Guide
Titan Uploads

Enable file uploads to your Gemini server using the Titan protocol. Configure upload directories, authentication tokens, size limits, and MIME type filtering.

Titan Uploads Guide

Guide Structure¶

Each how-to guide follows this structure:

Problem statement: What you want to accomplish
Prerequisites: What you need before starting
Steps: Clear, numbered instructions
Verification: How to confirm it worked
Troubleshooting: Common issues and solutions

How-To Guides¶

Available Guides¶

Guide Structure¶

See Also¶