Zeabur

https://zeabur.com/docs/en-US
Admin
Zeabur is a platform that helps you deploy your service with one click, supporting any programming...
Tokens:105,830
Snippets:1,619
Trust Score:9.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### View Installation Log

Source: https://zeabur.com/docs/en-US/wonder-mesh/get-started

Use this command to check the installation log for errors during the Wonder Mesh setup process.

```bash
cat /tmp/zeabur-install.log
```

--------------------------------

### Prompt to Get Started with InsForge

Source: https://zeabur.com/docs/en-US/integrations/insforge/quick-start

Use this prompt with your AI agent after connecting your AI IDE via MCP to fetch InsForge documentation.

```text
I'm using InsForge as my backend platform, fetch InsForge instruction doc to learn more about InsForge
```

--------------------------------

### Bootstrap Nue App with create-nue

Source: https://zeabur.com/docs/en-US/guides/nodejs/nue

Clone the create-nue repository, install dependencies, build the demo site, and start the HTTP server.

```bash
git clone https://github.com/nuejs/create-nue.git
 
cd create-nue

npm install

npm run start

open "http://localhost:8080"
```

--------------------------------

### Start Development Server

Source: https://zeabur.com/docs/en-US/guides/deno/fresh

Run this command to start the development server for your Fresh application.

```bash
deno task start
```

--------------------------------

### Install Django

Source: https://zeabur.com/docs/en-US/guides/python/django

Install the Django framework using pip. Ensure you have Python and pip installed first.

```bash
pip install django
```

--------------------------------

### Wonder Mesh Install Script Output

Source: https://zeabur.com/docs/en-US/wonder-mesh/get-started

This is an example of the successful output you should see after running the Wonder Mesh install script on your device. It confirms the installation of Tailscale, the Wonder binary, and SSH configuration.

```bash
=== Zeabur Mesh Server Setup ===
Installing Tailscale...
Tailscale installed: 1.94.2
Ensuring tailscaled is running...
Downloading wonder binary...
Joining Wonder Mesh Network...
Connecting to Wonder Mesh Net...
Successfully joined Wonder Mesh Net!
SSH server already running, skipping installation...
Enabling SSH password authentication...
Configuring SSH user...
Completing registration...
=== Zeabur Mesh Server Setup Complete ===
Mesh IP: 100.x.x.x
```

--------------------------------

### Start Qwik Development Server

Source: https://zeabur.com/docs/en-US/guides/nodejs/qwik

Navigate to your Qwik project directory and start the development server to see your application in action locally.

```bash
cd qwik-app
npm start
```

--------------------------------

### Install Hugo and Create New Site

Source: https://zeabur.com/docs/en-US/guides/static/hugo

Installs Hugo using Homebrew and creates a new Hugo site. Ensure Homebrew is installed before running.

```bash
brew install hugo
hugo new site my-hugo-site
cd my-hugo-site
```

--------------------------------

### Initialize MkDocs Project

Source: https://zeabur.com/docs/en-US/guides/static/mkdocs

Installs MkDocs, creates a new project, and navigates into the project directory. Ensure Python and pip are installed.

```bash
pip install mkdocs
mkdocs new my-project
cd my-project
```

--------------------------------

### Multi-stage Dockerfile Example

Source: https://zeabur.com/docs/en-US/deploy/methods/dockerfile

This multi-stage Dockerfile example demonstrates building a Node.js application and serving it with Nginx, utilizing ARG for build-time environment variables.

```dockerfile
FROM node:18-alpine AS builder
 
WORKDIR /app
COPY . .
 
## The `BUILDTIME_ENV_EXAMPLE` here will be set before building automatically
ARG BUILDTIME_ENV_EXAMPLE
ENV BUILDTIME_ENV_EXAMPLE=${BUILDTIME_ENV_EXAMPLE}
 
RUN npm install && \
    npm run build
 
FROM nginx:alpine
 
COPY nginx.conf /etc/nginx/conf.d/configfile.template
COPY --from=builder /app/dist /usr/share/nginx/html
 
ENV \
    PORT=8080 \
    HOST=0.0.0.0
 
EXPOSE 8080
 
CMD sh -c "envsubst '\$PORT' < /etc/nginx/conf.d/configfile.template > /etc/nginx/conf.d/default.conf && nginx -g 'daemon off;'"
```

--------------------------------

### Install Zeabur Svelte Adapter

Source: https://zeabur.com/docs/en-US/guides/nodejs/svelte-kit

Install the @zeabur/svelte-adapter as a development dependency using pnpm, npm, or yarn.

```bash
pnpm add -D @zeabur/svelte-adapter
```

```bash
npm install -D @zeabur/svelte-adapter
```

```bash
yarn add -D @zeabur/svelte-adapter
```

--------------------------------

### Install Project Dependencies

Source: https://zeabur.com/docs/en-US/guides/nodejs/svelte-kit

Install project dependencies using pnpm, npm, or yarn.

```bash
pnpm install
```

```bash
npm install
```

```bash
yarn
```

--------------------------------

### Caddyfile Configuration Example

Source: https://zeabur.com/docs/en-US/guides/static

Example Caddyfile configuration showing how to manage listening ports, unsafe paths, SPA logic with try_files, and extensions for redirects/headers.

```caddyfile
{
    # Do not modify the :8080 listening port.
    # The @unsafePath block contains the "unsafe paths."
    @unsafePath
    file /etc/caddy/unsafePaths

    # The try_files directive implements the SPA + MPA logic.
    try_files {path} /index.html

    # zeaburextension powers Zeabur’s _redirects and _headers features.
    zeaburextension

    # log writes Caddy server access logs to the Runtime Logs.
    log
}
```

--------------------------------

### Example pnpm-workspace.yaml for Turborepo

Source: https://zeabur.com/docs/en-US/guides/nodejs

This is an example `pnpm-workspace.yaml` file demonstrating how to define package directories in a Turborepo Monorepo.

```yaml
packages:
  - "apps/*"
  - "packages/*"
```

--------------------------------

### Install Dependencies with yarn

Source: https://zeabur.com/docs/en-US/guides/nodejs/nuxt

Install project dependencies using yarn.

```bash
yarn
```

--------------------------------

### Example Event Sign-up Link

Source: https://zeabur.com/docs/en-US/partner/event-partner/redeem-event-code

An example of a fully formed event sign-up link with a specific event code. This demonstrates how to replace the placeholder with an actual code.

```url
https://zeabur.com/events?code=i_love_zeabur
```

--------------------------------

### Install Dependencies with npm

Source: https://zeabur.com/docs/en-US/guides/nodejs/nuxt

Install project dependencies using npm.

```bash
npm install
```

--------------------------------

### Install Windsurf with InsForge

Source: https://zeabur.com/docs/en-US/integrations/insforge/connect-ai-ide

Use this command to install InsForge for Windsurf. Replace placeholders with your actual API key and endpoint.

```bash
npx @insforge/install --client windsurf --env API_KEY=YOUR_API_KEY --env API_BASE_URL=YOUR_API_ENDPOINT
```

--------------------------------

### Start Hugo Local Server

Source: https://zeabur.com/docs/en-US/guides/static/hugo

Starts the Hugo development server to preview your site locally. Visit http://localhost:1313/ to see the changes.

```bash
hugo server
```

--------------------------------

### Specify Build and Start Commands for Specific Services

Source: https://zeabur.com/docs/en-US/guides/nodejs

To set different build and start commands for individual services, create service-specific `zbpack.[service name].json` files. Settings in these files take priority over the general `zbpack.json`.

```json
// zbpack.api.json
{
    "build_command": "pnpm run build:api",
    "start_command": "pnpm run start:api"
}
```

```json
// zbpack.frontend.json
{
    "build_command": "pnpm run build:frontend",
    "start_command": "pnpm run start:frontend"
}
```

--------------------------------

### Install Cline with InsForge

Source: https://zeabur.com/docs/en-US/integrations/insforge/connect-ai-ide

Use this command to install InsForge for Cline. Replace placeholders with your actual API key and endpoint.

```bash
npx @insforge/install --client cline --env API_KEY=YOUR_API_KEY --env API_BASE_URL=YOUR_API_ENDPOINT
```

--------------------------------

### Install Vapor CLI

Source: https://zeabur.com/docs/en-US/guides/swift/vapor

Install the Vapor command-line interface using Homebrew. This is a prerequisite for creating and managing Vapor projects.

```bash
brew install vapor
```

--------------------------------

### Install Qwik Node.js (Express) Adaptor

Source: https://zeabur.com/docs/en-US/guides/nodejs/qwik

Install the Express adaptor package to enable your Qwik project to run on Zeabur's Node.js environment. This is a required step before deployment.

```bash
npm run qwik add express
```

--------------------------------

### Install Trae with InsForge

Source: https://zeabur.com/docs/en-US/integrations/insforge/connect-ai-ide

Use this command to install InsForge for Trae. Replace placeholders with your actual API key and endpoint.

```bash
npx @insforge/install --client trae --env API_KEY=YOUR_API_KEY --env API_BASE_URL=YOUR_API_ENDPOINT
```

--------------------------------

### Set Custom Start Command via Environment Variable

Source: https://zeabur.com/docs/en-US/guides/python

Use ZBPACK_START_COMMAND to prepend custom commands before the application starts. Ensure '_startup' is included to launch the application.

```bash
ZBPACK_START_COMMAND="python3 migrate.py && _startup"
```

--------------------------------

### Example Next.js Build Plan

Source: https://zeabur.com/docs/en-US/deploy/how-deploys-work

This is an example of a build plan generated by zbpack for a Next.js project. It details the Node.js version, package manager, and build commands.

```text
╔══════════════════════════════ Build Plan ═════════════════════════════╗
║ provider         │ nodejs                                             ║
║───────────────────────────────────────────────────────────────────────║
║ nodeVersion      │ 18                                                 ║
║───────────────────────────────────────────────────────────────────────║
║ installCmd       │ pnpm install                                       ║
║───────────────────────────────────────────────────────────────────────║
║ buildCmd         │ pnpm run build                                     ║
║───────────────────────────────────────────────────────────────────────║
║ startCmd         │ pnpm start                                         ║
║───────────────────────────────────────────────────────────────────────║
║ packageManager   │ pnpm                                               ║
║───────────────────────────────────────────────────────────────────────║
║ framework        │ next.js                                            ║
╚═══════════════════════════════════════════════════════════════════════╝
```

--------------------------------

### Install Project Dependencies

Source: https://zeabur.com/docs/en-US/get-started/migration/replit

Run the appropriate command to install project dependencies based on your package manager (npm or pnpm). Ensure a lock file exists to determine the correct manager.

```bash
# If using npm
npm install
```

```bash
# If using pnpm
pnpm install
```

--------------------------------

### Initialize Qwik Project

Source: https://zeabur.com/docs/en-US/guides/nodejs/qwik

Use this command to create a new Qwik project in your local environment. Follow the prompts to configure your project.

```bash
npm create qwik@latest
```

--------------------------------

### Modify Build and Start Commands with Environment Variables

Source: https://zeabur.com/docs/en-US/guides/nodejs

Custom build and start commands can also be set using environment variables. For example, `ZBPACK_BUILD_COMMAND` and `ZBPACK_START_COMMAND` can be used to specify commands for a particular service.

```bash
ZBPACK_BUILD_COMMAND=pnpm run build:api
ZBPACK_START_COMMAND=pnpm run start:api
```

--------------------------------

### Service Dependencies Example

Source: https://zeabur.com/docs/en-US/template/template-format

Declare services that the current service depends on. Zeabur will wait for these services to start before initiating the current service.

```yaml
dependencies:
    - redis
    - postgresql
```

--------------------------------

### Start Local Server for Testing Build

Source: https://zeabur.com/docs/en-US/guides/nodejs/qwik

Run the locally built Qwik project using Node.js to test the production build. Access it via http://localhost:3000 to ensure it functions as expected.

```bash
node server/entry.express.js
```

--------------------------------

### Initialize Fresh Project

Source: https://zeabur.com/docs/en-US/guides/deno/fresh

Use this command to initialize a new Deno project with the Fresh framework.

```bash
deno run -A -r https://fresh.deno.dev my-project
```

--------------------------------

### Initialize Hono Project with Bun

Source: https://zeabur.com/docs/en-US/guides/bun/hono

Create a new Hono project using the 'bun create hono' command. Navigate into the project directory and install dependencies.

```bash
bun create hono my-app
cd my-app
bun install
```

--------------------------------

### Install Bun

Source: https://zeabur.com/docs/en-US/guides/bun/elysiajs

Installs Bun, a JavaScript runtime, which is a prerequisite for ElysiaJS.

```bash
curl https://bun.sh/install | bash
```

--------------------------------

### Install Dependencies with pnpm

Source: https://zeabur.com/docs/en-US/guides/nodejs/nuxt

Install project dependencies using pnpm, including the shamefully-hoist flag.

```bash
pnpm install --shamefully-hoist
```

--------------------------------

### Test MkDocs Project Locally

Source: https://zeabur.com/docs/en-US/guides/static/mkdocs

Starts a local development server to preview the MkDocs site. Access the site at http://127.0.0.1:8000/.

```bash
mkdocs serve
```

--------------------------------

### Install Dependencies with pnpm

Source: https://zeabur.com/docs/en-US/get-started/migration/emergent

Install project dependencies using pnpm. Ensure you have a pnpm-lock.yaml file.

```bash
# If using pnpm
pnpm install

```

--------------------------------

### Initialize Git and Commit Project Files

Source: https://zeabur.com/docs/en-US/guides/dart/flutter

Initialize a Git repository and commit your project files before deploying with Zeabur CLI. This ensures your project is under version control.

```bash
git init
git add -A
git commit -m "Initial commit"
```

--------------------------------

### Install Dependencies with npm

Source: https://zeabur.com/docs/en-US/get-started/migration/emergent

Install project dependencies using npm. Ensure you have a package.json file.

```bash
# If using npm
npm install

```

--------------------------------

### Run Development Server

Source: https://zeabur.com/docs/en-US/get-started/migration/aistudio

Start the local development server to test your application. This command is typically used with npm.

```bash
npm run dev
```

--------------------------------

### Install Bun Types

Source: https://zeabur.com/docs/en-US/guides/bun

Install `bun-types` as a development dependency if you prefer not to commit the `bun.lockb` file to your repository.

```json
{
  "devDependencies": {
    "bun-types": "latest"
  }
}
```

--------------------------------

### Initialize a Bun App

Source: https://zeabur.com/docs/en-US/guides/bun

Use these commands to create a new Bun project directory and initialize a Bun application within it.

```bash
mkdir bun-app

cd bun-app

bun init
```

--------------------------------

### Deploy a Service with Zeabur CLI

Source: https://zeabur.com/docs/en-US/developer/cli

Run this command in your project directory to automatically detect the framework and deploy your service. It guides you through project selection or creation.

```bash
npx zeabur@latest deploy
```

--------------------------------

### Example Fly.io Configuration

Source: https://zeabur.com/docs/en-US/get-started/migration/fly-io

Review your fly.toml file to understand your application's configuration, including environment variables, internal ports, and volumes.

```toml
# fly.toml — example
app = "my-app"

[env]
  NODE_ENV = "production"
  PORT = "8080"

[http_service]
  internal_port = 8080

[[vm]]
  memory = "512mb"
  cpu_kind = "shared"
```

--------------------------------

### Install NestJS CLI

Source: https://zeabur.com/docs/en-US/guides/nodejs/nestjs

Installs the NestJS command-line interface globally. Use this to create new NestJS projects.

```bash
npm install -g @nestjs/cli
```

--------------------------------

### Install Project Dependencies with npm

Source: https://zeabur.com/docs/en-US/get-started/migration/lovable

Use this command to install the libraries required by your Lovable project when using npm.

```bash
npm install

```

--------------------------------

### Install pnpm Dependencies

Source: https://zeabur.com/docs/en-US/get-started/migration/aistudio

Install project dependencies using pnpm. This command is used when a pnpm-lock.yaml file is present.

```bash
# If using pnpm
pnpm install
```

--------------------------------

### Run Local Development Server

Source: https://zeabur.com/docs/en-US/get-started/migration/emergent

Start the development server to test your application locally. This command is typically defined in your package.json scripts.

```bash
npm run dev

```

--------------------------------

### Install npm Dependencies

Source: https://zeabur.com/docs/en-US/get-started/migration/aistudio

Install project dependencies using npm. This command is used when a package-lock.json file is present.

```bash
# If using npm
npm install
```

--------------------------------

### Build Qwik Project Locally

Source: https://zeabur.com/docs/en-US/guides/nodejs/qwik

Build your Qwik project to generate production-ready files. This step helps verify that your project builds correctly before deploying.

```bash
npm run build
```

--------------------------------

### Set Custom Start Command in zbpack.json

Source: https://zeabur.com/docs/en-US/guides/php

Configure the start_command in `zbpack.json` to execute commands during server startup. Ensure to include `_startup` for the PHP server to initiate correctly.

```json
{
    "start_command": "php artisan migrate && _startup"
}
```

--------------------------------

### Create deno.json configuration

Source: https://zeabur.com/docs/en-US/guides/deno/typescript

Creates the deno.json file and adds a start command for running the Deno application.

```bash
touch deno.json
```

```json
# in deno.json
{
  "tasks": {
    "start": "deno run --allow-net --allow-env --allow-read main.ts"
  }
}
```

--------------------------------

### Create a Bun HTTP Server

Source: https://zeabur.com/docs/en-US/guides/bun

Implement a simple HTTP server using `Bun.serve`. Ensure the port is configured to use `Bun.env.PORT` for compatibility with Zeabur's environment.

```typescript
const server = Bun.serve({
  port: Bun.env.PORT ?? 3000, // modify the port to Bun.env.PORT
  fetch() {
    return new Response("Bun on Zeabur!");
  },
});

console.log(`Listening on http://localhost:${server.port} ...`);
```

--------------------------------

### Check Flutter Installation

Source: https://zeabur.com/docs/en-US/guides/dart/flutter

Verify if Flutter is installed correctly by running this command. Ensure all check items are green before proceeding.

```bash
flutter doctor
```

--------------------------------

### Install Project Dependencies

Source: https://zeabur.com/docs/en-US/get-started/migration/bolt

Install project dependencies using either npm or pnpm. pnpm is commonly used in Bolt projects.

```bash
# If using npm
npm install

```

```bash
# If using pnpm (common in Bolt)
pnpm install

```

--------------------------------

### Create Astro Project

Source: https://zeabur.com/docs/en-US/guides/nodejs/astro

Use npm to create a new Astro project. Follow the prompts for configuration.

```bash
npm create astro@latest
```

--------------------------------

### Clone Repository and Navigate

Source: https://zeabur.com/docs/en-US/get-started/migration/emergent

Clone your GitHub repository locally and navigate into the project directory.

```bash
git clone <https://github.com/your-username/your-repo-name.git>
cd your-repo-name

```

--------------------------------

### Example Tar File Extraction

Source: https://zeabur.com/docs/en-US/operations/data/file-management

An example demonstrating how to extract a tar file named 'myfolder.tar' located in '/tmp' to the '/usr/share' directory.

```bash
tar xvf /tmp/myfolder.tar -C /usr/share
```

--------------------------------

### Create Nuxt App with npx

Source: https://zeabur.com/docs/en-US/guides/nodejs/nuxt

Use this command to initialize a new Nuxt project using npx.

```bash
npx nuxi init <project-name>
```

--------------------------------

### Send Single Email Example (cURL)

Source: https://zeabur.com/docs/en-US/email/rest-api

Example of sending a single email using cURL, including authentication and request body.

```bash
curl -X POST https://api.zeabur.com/api/v1/zsend/emails \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "from": "hello@yourdomain.com",
    "to": ["user@example.com"],
    "subject": "Welcome to Zeabur Email",
    "html": "<h1>Welcome!</h1><p>Thank you for using Zeabur Email.</p>"
  }'
```

--------------------------------

### Initialize New Reflex Project

Source: https://zeabur.com/docs/en-US/guides/python/reflex

Use the Reflex CLI to initialize a new Reflex project. This command scaffolds the basic project structure.

```bash
reflex init
```

--------------------------------

### Zeabur Email API Response Example

Source: https://zeabur.com/docs/en-US/email/quick-start

Example of a successful response when queuing an email for sending via the Zeabur Email API.

```json
{
  "email_id": "696de2c84210d814d66ee052",
  "status": "queued",
  "message": "Email queued for sending"
}
```

--------------------------------

### Install Roo Code with InsForge

Source: https://zeabur.com/docs/en-US/integrations/insforge/connect-ai-ide

Use this command to install InsForge for Roo Code. Replace placeholders with your actual API key and endpoint.

```bash
npx @insforge/install --client roocode --env API_KEY=YOUR_API_KEY --env API_BASE_URL=YOUR_API_ENDPOINT
```

--------------------------------

### Install Project Dependencies (pnpm)

Source: https://zeabur.com/docs/en-US/guides/nodejs/nestjs

Installs project dependencies using pnpm. This command is used after cloning a project or creating a new one.

```bash
pnpm install
```
Tokens:
Raw