Quick Start
Ric Harvey edited this page 2025-12-03 20:24:07 +00:00

Page revisions

5 Commits

Author SHA1 Message Date
1711ac2ba2
Update Quick Start guide to version 0.0.8
Updated plugin version references from v0.0.7 to v0.0.8 in
Traefik configuration examples.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-03 20:24:07 +00:00
58e972df6f
Add prominent Redis/Valkey requirement section to Quick Start
Added "Important: Redis/Valkey Requirement" section highlighting that
Redis or Valkey is strongly recommended for production deployments.

Key points covered:
- Custom domain HTTPS requires Redis for Traefik provider
- Persistent caching across plugin restarts
- Shared cache for multiple Traefik instances
- Custom domain mapping persistence
- Clear list of features unavailable without Redis
- Quick setup commands for Docker
- Added Redis/Valkey to prerequisites list

This ensures users understand Redis is essential for full functionality,
especially custom domain HTTPS support.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-03 15:28:04 +00:00
8632605e9d
Add Redis provider configuration to Traefik setup examples
Updated both Docker Compose and Standalone Traefik sections to include
Redis provider configuration in traefik.yml:
- Added providers.redis section with endpoints and rootKey
- Included optional password authentication
- Added configuration notes explaining Redis provider purpose
- Linked to Traefik Redis Provider documentation
- Noted that Redis provider is required for custom domain SSL

This enables dynamic router registration for custom domains with
automatic SSL certificate generation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-03 15:26:18 +00:00
e20f8ebeda
Update Architecture Overview to use Mermaid.js diagram
Replaced ASCII text diagram with interactive Mermaid.js flowchart showing:
- User browser → Traefik → Bovine Pages → Forgejo API flow
- Optional Redis caching integration
- Color-coded components for better visualization
- Bidirectional data flow representation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-03 15:23:40 +00:00
9b6ee60d54
Create comprehensive Quick Start guide with Traefik and Docker setup
Split Quick Start section from Home page into dedicated comprehensive guide:
- Added detailed Docker Compose setup instructions
- Added standalone Traefik setup instructions
- Included architecture overview and prerequisites
- Added complete configuration examples with explanations
- Included troubleshooting section
- Added verification steps
- Linked to Traefik and Docker documentation
- Provided next steps and additional resources

Updated Home page:
- Added Quick Start link to Getting Started section
- Replaced inline setup with link to comprehensive guide

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-03 15:19:39 +00:00