ZShip

~/zship/docs

Start shipping ZShip here.

One entry point for deployment docs. Start the console, follow the shortest path, then open the directory tree only when you need a specific topic.

zship

$pnpm dev:console

# run checks, migrations, env setup, and deploy steps locally

openhttp://localhost:3900

recommendedDev ConsoleBrowser-guided checks, migrations, environment variables, and Cloudflare deploys.manualCLITerminal-first steps for CI or manual control.

Shortest reading path

Three pages are enough for a first pass.

01 / readIntroduction02 / choose pathDeployment Guide03 / check rulesImportant Notes
37 docs / 6 sections

docs/

Directory tree

Collapsed by topic. Open what you need.

Start here/3
docs/introductionIntroductiondocs/important-notesImportant Notesdocs/codebaseCodebase
Deployment/14
docs/deployment-guideDeployment Guidedocs/cli-01-before-startCLI: Before You Startdocs/cli-02-local-devCLI: Local Developmentdocs/cli-03-cloudflare-resourcesCLI: Prepare Cloudflare Resourcesdocs/cli-04-deploy-workersCLI: Deploy Backend Workersdocs/cli-05-deploy-pagesCLI: Deploy Frontend Pagesdocs/deploy-00-dev-console00. Meet the Dev Consoledocs/deploy-01-before-start01. Before You Startdocs/deploy-02-cloudflare-resources02. Deploy to Cloudflaredocs/deploy-03-backend-workers03. Deploy Backend Workersdocs/deploy-04-frontend-pages04. Deploy Frontend Pagesdocs/deploy-05-domain-env05. Bind Domains and Environment Variablesdocs/deploy-06-initialization06. Initialize Your Systemdocs/deploy-07-troubleshooting07. Launch Checks and Common Errors
Integrations/11
docs/integrations/authenticationAuthenticationdocs/github-oauth-setupGitHub OAuth Setupdocs/integrations/paymentPaymentdocs/integrations/subscription-managementSubscription Managementdocs/integrations/aiAIdocs/integrations/emailEmaildocs/integrations/storageStoragedocs/integrations/blogBlogdocs/integrations/checkinCheck-indocs/integrations/notifyNotifydocs/integrations/crispCrisp
Customization/2
docs/customization/brandingBrandingdocs/customization/i18ni18n
Development/4
docs/development/skillsDevelopment Skillsdocs/development/admin-rbacAdmin RBAC & operator accountsdocs/development/custom-admin-platformBuilding a custom admin for special business logicdocs/development/platform-zship-appapp.zship.ai (post-purchase site)
Value-added services/3
docs/value-added/overviewValue-Added Servicesdocs/value-added/ai-providerAI Provider Servicedocs/value-added/ai-provider-turnstileAI Provider Turnstile

Full reference stays folded to keep the page scannable.