HCTHE HCLAB

Usage & configuration overview

Operate and configure a running THE HCLAB deployment.

This section covers day-two operations: environment reference, access control, maintenance, and background processing.

Quick links

Topic When you need it
Environment variables Adding or rotating secrets
Roles & permissions Onboarding staff or researchers
Maintenance mode Planned downtime
Background jobs Cron setup and exports

Configuration sources

Source Contents
.env / Vercel env Secrets and feature flags
prisma/schema.prisma Data model
src/lib/site.ts Public navigation
src/lib/docs-nav.ts Documentation structure
src/lib/roles.ts Role group definitions

Changing public navigation

Header nav is defined in src/lib/site.ts (headerNav). Footer links use footerNavLinks in the same file.

Changing documentation

  1. Edit Markdown under content/docs/<section>/<page>.md
  2. Update src/lib/docs-nav.ts if adding/removing pages or sections
  3. Deploy — docs are static at build time via generateStaticParams

Getting help

  • Admin dashboard — platform analytics at /admin
  • Event log/admin/events for research and system events
  • Prisma Studionpm run db:studio for direct data inspection (dev/staging only)