Skip to main content

Hosting the Public Docusaurus Documentation Site

Keeping the Core Source Repository Private While Exposing a World-Class Public Docs Hub​

Public Site Safe Docusaurus 3 Docker Powered

Quantum Tiger (Morning Bay Technology Pvt. Ltd.)
Automated synchronization from repository documentation and wiki into a blazing fast, static documentation portal.

Docs Hub - Installation - Backups - [PRIVATE] Security


Architecture & Privacy Guarantee​

Organizations often require their source code, Go backends, internal database schemas, and proprietary algorithms to remain strictly private in a protected Git repository, while allowing customers, employees, administrators, and external developers to browse comprehensive user guides, operational runbooks, and API documentation on a public website (e.g., https://docs.quantumtiger.in).

Strict Separation: Client Deployment vs. Our Documentation Cloud​

DimensionClient Side (Enterprise On-Premise)Our Side (Quantum Tiger Central Cloud)
Deployment Commandcurl -fsSL .../install.sh | sudo bashDeployed via Coolify / .gitea/workflows/docs-site.yaml
Hosted Servicesorigin-app, origin-postgres, origin-minio, origin-nginxorigin-docs (Alpine Nginx static Docusaurus bundle)
Documentation Container[FAILED] NOT HOSTED (Zero docs containers or overhead)[ENABLED] HOSTED EXCLUSIVELY at https://docs.quantumtiger.in
Help & Docs LinksPoints externally to https://docs.quantumtiger.inServes public static documentation guides
Privacy PostureClient data remains 100% sovereign within client networkCore source repository stays private; only static docs exposed

Origin by Corvus achieves this with an automated multi-stage compilation model:


Quick Deployment Options​

Run the standalone public documentation site on any server:

docker compose -f docker-compose.docs.yml up -d --build

The documentation portal will start listening on port 3000 (configurable via DOCS_PORT environment variable). Test with:

curl http://localhost:3000/healthz

Option 2: Continuous Deployment via Coolify​

You can host the public documentation site effortlessly on Coolify:

  1. In Coolify:
    • Click + Create New Resource -> Application.
    • Select your private Gitea/GitHub Git Source (Origin-By-Corvus).
    • Set Build Pack to Docker Compose or Dockerfile.
    • If using Dockerfile: set Dockerfile Path to Dockerfile.docs.
    • Set the public FQDN (e.g. https://docs.quantumtiger.in). Coolify automatically configures Traefik reverse proxy and Let's Encrypt TLS certificates.
  2. In Gitea Actions:
    • In Gitea repository settings (Settings -> Actions -> Secrets), configure:
      • COOLIFY_URL: https://server.projectdefcorp.com
      • COOLIFY_DEPLOY_TOKEN / COOLIFY_TOKEN: Your API token
      • COOLIFY_DOCS_APP_UUID: Application UUID of the docs app in Coolify
    • On every push modifying docs/, Gitea Actions automatically triggers deployment and streams live build logs!

Automatic Documentation Synchronization​

The Docusaurus site compiles from the authoritative docs/ structure using docs/site/scripts/sync-docs-and-wiki.mjs:

Running Local Sync Manually​

cd docs/site
npm run sync:docs

Security & Privacy Checklist​

  • Zero Server Binaries: Go server executable and templates are completely excluded.
  • Zero Database Schemas: Raw SQL files and database configuration parameters are omitted.
  • Zero Secrets & Credentials: No .env or configuration tokens are baked into the container.
  • Lightweight Footprint: The final production container image is less than 35 MB compressed.
  • HTTP Security Headers: Nginx serves X-Frame-Options: SAMEORIGIN, X-Content-Type-Options: nosniff, and strict referrer policies.
  • Static Asset Caching: JavaScript and CSS bundles carry 1-year immutable cache headers for optimal performance.

Related guides: Installation Guide, Security Architecture, Updating & Rollback.