mirror of
https://github.com/RayLabsHQ/gitea-mirror.git
synced 2026-08-08 01:43:11 +02:00
ARUNAVO RAY
5c49191d61
* docs: move canonical documentation to the website The website now hosts the full documentation at /docs with a proper docs layout: sidebar navigation, on-page table of contents, mobile nav, theme support, canonical and OG meta, and overflow-safe code blocks and tables. Ten pages, all rewritten from the current code rather than copied from the old in-app docs: quickstart, deployment (Docker, Helm, Nix, LXC, bare metal), configuration, environment variable reference, notifications (all four providers including webhook payload signing), authentication (including header auth), force-push protection, architecture, advanced, and custom CA certificates. This fixes every inaccuracy found in the docs audit: the wrong raylabs/gitea-mirror image name, JWT_SECRET presented as the live auth secret instead of BETTER_AUTH_SECRET, the missing auth env vars, both wrong DATABASE_URL defaults, the contradicting starred-org default, and health endpoint fields the API deliberately does not return. The in-app /docs pages are retired: a stub redirects old bookmarks to the website, and the sidebar and 404 links point there directly. The markdown files under docs/ stay as the versioned offline reference; NOTIFICATIONS.md now covers Gotify and Webhook. README links the docs site, mentions notifications, and drops stale version markers. The app viewport meta gains initial-scale=1. * docs: mark new-repo notification as unimplemented, bump helm appVersion to 3.24.0
Gitea Mirror Documentation
This folder contains engineering and operations references for the open-source Gitea Mirror project. Each guide focuses on the parts of the system that still require bespoke explanation beyond the in-app help and the main README.md.
Available Guides
Core workflow
- DEVELOPMENT_WORKFLOW.md – Set up a local environment, run scripts, and understand the repo layout (app + marketing site).
- ENVIRONMENT_VARIABLES.md – Complete reference for every configuration flag supported by the app and Docker images.
- NIX_DEPLOYMENT.md – User-facing deployment guide for Nix and NixOS.
- NIX_DISTRIBUTION.md – Maintainer notes for packaging, releases, and distribution strategy.
Reliability & recovery
- GRACEFUL_SHUTDOWN.md – How signal handling, shutdown coordination, and job persistence work in v3.
- RECOVERY_IMPROVEMENTS.md – Deep dive into the startup recovery workflow and supporting scripts.
Authentication
- SSO-OIDC-SETUP.md – Configure OIDC/SSO providers through the admin UI.
- SSO_TESTING.md – Recipes for local and staging SSO testing (Google, Keycloak, mock providers).
If you are looking for customer-facing playbooks, see the MDX use cases under www/src/pages/use-cases/.
Quick start for local development
git clone https://github.com/RayLabsHQ/gitea-mirror.git
cd gitea-mirror
bun run setup # installs deps and seeds the SQLite DB
bun run dev # starts the Astro/Bun app on http://localhost:4321
The first user you create locally becomes the administrator. All other configuration—GitHub owners, Gitea targets, scheduling, cleanup—is done through the Configuration screen in the UI.
Contributing & support
- 🎯 Contribution guide: ../CONTRIBUTING.md
- 🐞 Issues & feature requests: https://github.com/RayLabsHQ/gitea-mirror/issues
- 💬 Discussions: https://github.com/RayLabsHQ/gitea-mirror/discussions
- 🔐 Security policy & advisories: https://github.com/RayLabsHQ/gitea-mirror/security