mirror of
https://github.com/RayLabsHQ/gitea-mirror.git
synced 2026-10-30 22:21:58 +01:00
Move canonical docs to the website (#354)
* 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
This commit is contained in:
1 parent
63a4c9359a
commit
5c49191d61
27 files changed
+2840
-2931
No files matched your search
@@ -21,6 +21,8 @@ docker compose -f docker-compose.alt.yml up -d
|
||||
|
||||
First user signup becomes admin. Configure GitHub and Gitea/Forgejo through the web interface!
|
||||
|
||||
📖 **[Full documentation](https://gitea-mirror.raylabs.io/docs/)** - quickstart, deployment, configuration, notifications, SSO and more. Offline copies live in [`docs/`](docs/).
|
||||
|
||||
<p align="center">
|
||||
<img src=".github/assets/dashboard.png" alt="Dashboard" width="600" />
|
||||
<img src=".github/assets/dashboard_mobile.png" alt="Dashboard Mobile" width="200" />
|
||||
@@ -33,15 +35,16 @@ First user signup becomes admin. Configure GitHub and Gitea/Forgejo through the
|
||||
- 🏢 Mirror entire organizations with flexible strategies
|
||||
- 🎯 Custom destination control for repos and organizations
|
||||
- 📦 **Git LFS support** - Mirror large files with Git LFS
|
||||
- 📝 **Metadata mirroring** - Issues, pull requests (as issues), labels, milestones, wiki
|
||||
- 📝 **Metadata mirroring** - Issues, pull requests (as issues), labels, milestones, releases, wiki
|
||||
- 🚫 **Repository ignore** - Mark specific repos to skip
|
||||
- 🔐 Secure authentication with Better Auth (email/password, SSO, OIDC)
|
||||
- 🔐 Secure authentication with Better Auth (email/password, SSO, OIDC, header auth)
|
||||
- 🔔 **[Notifications](docs/NOTIFICATIONS.md)** - ntfy, Apprise, Gotify, or any webhook with signed payloads
|
||||
- 📊 Real-time dashboard with activity logs
|
||||
- ⏱️ Scheduled automatic mirroring with configurable intervals
|
||||
- 🔄 **Auto-discovery** - Automatically import new GitHub repositories (v3.4.0+)
|
||||
- 🧹 **Repository cleanup** - Auto-remove repos deleted from GitHub (v3.4.0+)
|
||||
- 🎯 **Proper mirror intervals** - Respects configured sync intervals (v3.4.0+)
|
||||
- 🛡️ **[Force-push protection](docs/FORCE_PUSH_PROTECTION.md)** - Smart detection with backup-on-demand or block-and-approve modes (Beta)
|
||||
- 🔄 **Auto-discovery** - Automatically import new GitHub repositories
|
||||
- 🧹 **Repository cleanup** - Auto-remove repos deleted from GitHub
|
||||
- 🎯 **Proper mirror intervals** - Respects configured sync intervals
|
||||
- 🛡️ **[Force-push protection](docs/FORCE_PUSH_PROTECTION.md)** - Smart detection with backup-on-demand or block-and-approve modes
|
||||
- 🗑️ Automatic database cleanup with configurable retention
|
||||
- 🐳 Dockerized with multi-arch support (AMD64/ARM64)
|
||||
|
||||
@@ -49,7 +52,7 @@ First user signup becomes admin. Configure GitHub and Gitea/Forgejo through the
|
||||
|
||||
<div align="center">
|
||||
<img src=".github/assets/repositories.png" alt="Repositories" width="600" />
|
||||
<img src=".github/assets/repositories_mobile.png" alt="Rrepositories Mobile" width="200" />
|
||||
<img src=".github/assets/repositories_mobile.png" alt="Repositories Mobile" width="200" />
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
|
||||
Reference in new issue
Block a user