Deployment

Deploy ClearDocs to your preferred hosting platform with a single click or configure a manual deployment on your own infrastructure.

One-Click Deploy

Click any button below to clone, configure, and deploy a ClearDocs instance:

Each platform clones the repository into your account, prompts for environment variables, and deploys a production-ready site.

Vercel

Vercel is the native hosting platform for Next.js. It auto-detects the framework, configures the build pipeline, and deploys with zero configuration. The deploy button prompts for all required environment variables during setup.

What happens when you click Deploy:

Clone repository — Vercel clones the repository into your GitHub account
Configure environment — You fill in the required environment variables (ACCESS_MODE, APP_PASSWORD, JWT_SECRET, COOKIE_SALT, THEME_VARIANT)
Build and deploy — Vercel builds and deploys the site automatically
Go live — Your documentation site is live with a .vercel.app URL

Netlify

Netlify supports Next.js through the OpenNext adapter, which is auto-installed during the build process. The included netlify.toml configuration file prompts for environment variables during deployment.

What happens when you click Deploy:

Clone repository — Netlify clones the repository into your GitHub account
Configure environment — The netlify.toml template prompts for environment variables
Build with OpenNext — Netlify installs the OpenNext adapter and builds the site
Go live — Your documentation site is live with a .netlify.app URL

Render

Render deploys ClearDocs as a web service using the included render.yaml blueprint. Secrets like JWT_SECRET and COOKIE_SALT are auto-generated during deployment.

What happens when you click Deploy:

Clone repository — Render clones the repository into your account
Apply blueprint — The render.yaml blueprint configures the web service with auto-generated secrets
Build — Render installs dependencies and builds the site
Go live — Your documentation site is live with an .onrender.com URL

Environment Variables

All platforms require the same set of environment variables. The setup script (scripts/setup-env.sh) generates these automatically for local development. For cloud deployments, configure them through your platform's dashboard or during the one-click deploy flow.

Variable	Description	Default
`ACCESS_MODE`	`public` (open access) or `private` (password-protected)	`public`
`APP_PASSWORD`	Site access password (required for private mode)	—
`JWT_SECRET`	JWT token signing key (required for private mode)	—
`COOKIE_SALT`	Secure cookie name generation salt (required for private mode)	—
`THEME_VARIANT`	Color theme from 26 options	`emerald`
`NEXT_PUBLIC_FOOTER_COMPANY_NAME`	Company name displayed in the footer	—
`NEXT_PUBLIC_FOOTER_COMPANY_URL`	Company URL linked in the footer	—
`NEXT_PUBLIC_SITE_URL`	Full site URL for sitemap and OpenGraph tags	—

Manual Deployment

For any Node.js hosting provider, build and start ClearDocs with:

Bash

npm install
npm run build
npm start

The production server starts on port 3000 by default. Set environment variables through your hosting provider's dashboard or a .env.local file before building.