Skip to main content
Documentation
StartOverviewArchitectureAuthenticationSend your first message
TypeScript SDKOverviewTrusted app serverApp-user clientsRealtimeErrors & webhooks
Flutter SDKOverviewInstallationAuthenticationChannels & messagesOffline & syncRealtimeUI componentsPush & lifecycle
ConceptsTenancy & scopeChannels & messagesDelivery & reconciliationSecurity checklist
ProtocolsRealtimeSigned webhooks
ReferenceREST APIErrors, limits & retriesDeploy docs to Coolify
VV ChatDocs API v1
Recommended starting points
Build chat without rebuilding infrastructureV Chat is a multi-tenant messaging backend with typed server, web, and Flutter integration paths.StartArchitecture at a glanceUnderstand the control plane, data plane, realtime path, and SDK boundaries before integrating.StartAuthentication and credentialsSelect the correct credential for dashboard, trusted-server, app-user, realtime, and webhook flows.StartSend your first messageUse the trusted TypeScript server client to create the minimum safe messaging flow.StartTypeScript SDK overviewChoose the correct typed client for trusted servers, app users, dashboard sessions, realtime, and webhooks.TypeScript SDKTrusted app-server clientUse AppServerClient from a protected backend to manage data-plane resources and mint app-user tokens.TypeScript SDKApp-user clientsBuild browser or Node app-user flows with VChatClient or the lower-level AppUserClient.TypeScript SDK
↑↓ Navigate↵ Openesc Close
API reference
StartOverviewArchitectureAuthenticationSend your first message
TypeScript SDKOverviewTrusted app serverApp-user clientsRealtimeErrors & webhooks
Flutter SDKOverviewInstallationAuthenticationChannels & messagesOffline & syncRealtimeUI componentsPush & lifecycle
ConceptsTenancy & scopeChannels & messagesDelivery & reconciliationSecurity checklist
ProtocolsRealtimeSigned webhooks
ReferenceREST APIErrors, limits & retriesDeploy docs to Coolify
Contract sourceOpenAPI JSON
Docs/Deployment
Standalone docs app

Deploy the docs portal to Coolify

Build and run the standalone documentation application as an independent, stateless Coolify service.

Updated 2026-08-09•apps/docs/Dockerfile · apps/docs/COOLIFY.md

Deployment boundary

Deploy the docs portal as a separate Coolify application and hostname. It is stateless, has no database, does not need V Chat credentials, and remains independent from the API/dashboard/worker Compose stack and the existing marketing landing page.

Coolify settings

SettingValue
Build packDockerfile
Base directory/
Dockerfile location/apps/docs/Dockerfile
Port3000
Health path/api/health
Required secretsNone

Build and verify locally

bash
docker build -f apps/docs/Dockerfile -t vchat-docs:local .
docker run --rm -p 3000:3000 vchat-docs:local

curl --fail http://127.0.0.1:3000/api/health
Health scope

The docs health endpoint proves only that the documentation process can serve requests. It does not prove API, MongoDB, Redis, worker, webhook, or realtime readiness.

Rollout and rollback

  1. Build an immutable image from the reviewed docs branch and record its digest.
  2. Deploy to a staging docs hostname and run route, search, responsive, keyboard, link, and health smoke checks.
  3. Promote the same digest to the public docs hostname.
  4. Rollback by restoring the prior image digest and redeploying. No database action is needed.
PreviousREST API reference
On this pageDeployment boundaryCoolify settingsBuild and verify locallyRollout and rollback
Report a docs issue