Documentation

Welcome to the Bovine Pages Server documentation! This initiative brings “GitHub Pages-style static site hosting” to Forgejo and Gitea.

What is Bovine Pages Server?

Bovine Pages Server operates as a Traefik middleware plugin, converting self-hosted Forgejo or Gitea instances into static site hosting platforms comparable to GitHub Pages, GitLab Pages, and Codeberg Pages.

Key Capabilities

The system integrates into existing Traefik reverse proxy setups without separate web servers. It serves static files from the public/ folder of repositories, making deployment straightforward through standard git workflows. The plugin enables hosting of documentation, project websites, blogs, and web applications while keeping content versioned alongside source code.

Featured Highlights

• Static site hosting from public/ directories
• Automatic HTTPS with Let’s Encrypt support
• Custom domain capability
• URL redirects for custom domains
• Password protection for restricted access
• Directory index functionality
• Apache-style directory listings
• Redis caching integration
• Profile sites and custom error pages

Quick Start Overview

Setup involves:

1. Adding the plugin to Traefik configuration
2. Configuring middleware parameters including the pages domain and Forgejo host URL
3. Creating a repository with public/ folder and .pages configuration file

Documentation Structure

Features

• Custom Domains - Use your own domain names with full DNS configuration support
• Custom Domain Redirects - Set up automatic URL redirects for your custom domains
• Password Protection - Secure sites with SHA256-hashed passwords
• Cache Reaper - Maintain and manage your cache
• Directory Listings - Apache-style file browser for directories

Technical Documentation

• Redis Implementation - Redis client implementation details
• Redis Testing - Testing guide for Redis integration
• Implementation Summary - Complete project overview

Support

For issues, questions, or contributions, visit the repository.