Zerops Documentation

https://github.com/zeropsio/docs
Admin
This project provides comprehensive documentation for users seeking assistance with interacting with...
Tokens:826,705
Snippets:6,014
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### install usage examples

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/references/zsc.mdx

Examples of installing different base technologies using zsc install.

```sh
zsc install rust@1.78
zsc install dotnet@8
zsc install nginx@1.22
```

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

### Set up environment and install dependencies

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/src/components/backup/frameworks/laravel/recipes/minimal-local.mdx

Create the environment file from the example, install Composer dependencies, and generate an application key. Fill in database access details from the Zerops GUI before running these commands.

```bash
# Create and configure environment file
cp .env.example .env
```

```bash
composer install
php artisan key:generate
```

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

### Basic Ubuntu runtime setup in zerops.yml

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/ubuntu/how-to/customize-runtime.mdx

Basic Ubuntu runtime setup in zerops.yml. Sets the base image to the default Ubuntu version and installs system packages (imagemagick, ffmpeg) via apt-get in the prepareCommands. Use this as a starting point for customizing the runtime environment.

```yaml
...
  run:
    base: {{serviceVersion}}
    prepareCommands:
      - sudo apt-get update
      - sudo apt-get install -y imagemagick ffmpeg
```

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

### Basic extends example with `base` and `prod` setup

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/static/llms-small.txt

Defines a `base` setup and a `prod` setup that extends it, overriding the build command and adding environment variables. The child deep-copies the parent and applies its own keys on top.

```yaml
zerops:
  - setup: base
    build: { buildCommands: [npm run build], deployFiles: ./dist }
    run: { start: npm start }
  - setup: prod
    extends: base
    run: { envVariables: { NODE_ENV: production } }
```

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

### Complete zerops.yaml configuration example

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/static/llms-small.txt

This example shows a full zerops.yaml file with a setup section, build configuration using Node.js, and a runtime configuration using Nginx. The build section installs dependencies, builds the app, deploys dist, package.json, and node_modules, and caches node_modules. The run section sets the base to alpine/nginx, defines the document root as public, and specifies a custom Nginx config path.

```yaml
zerops:
  # define hostname of your service
  - setup: app
    # ==== how to build your application ====
    # OPTIONAL. If you need to build your static files using a framework,
    # configure the build environment here. If you already have built files,
    # you can skip this entire section and deploy directly to the runtime.
    build:
      # REQUIRED (if using build). Set the base technology for the build environment:
      base: nodejs@latest

      # OPTIONAL. Customize the build environment by installing additional packages
      # or tools to the base build environment.
      # prepareCommands:
      #   - sudo apt-get something
      #   - curl something else

      # OPTIONAL. Build your application
      buildCommands:
        - npm i
        - npm run build

      # REQUIRED (if using build). Select which files / folders to deploy after
      # the build has successfully finished
      deployFiles:
        - dist
        - package.json
        - node_modules

      # OPTIONAL. Which files / folders you want to cache for the next build.
      # Next builds will be faster when the cache is used.
      cache: node_modules

    # ==== how to run your application ====
    run:
      # OPTIONAL. Sets the base technology and OS for the runtime environment:
      base: alpine/nginx@latest

      # OPTIONAL. Customize the runtime Nginx environment by installing additional
      # dependencies to the base Nginx runtime environment.
      # prepareCommands:
      #   - sudo apt-get something
      #   - curl something else

      # OPTIONAL. Run one or more commands each time a new runtime container
      # is started or restarted. These commands are triggered before
      # your Nginx application is started.
      # initCommands:
      #  - rm -rf ./cache

      # OPTIONAL. Customize the folder that will be used as the root of the publicly
      # accessible web server content. Enter the path relative to the /var/www folder.
      documentRoot: public

      # OPTIONAL. Sets the custom Nginx configuration. The file must be deployed in
      # the runtime container. Enter the path to the file relative to the /var/www folder
      siteConfigPath: site_config.tmpl

```

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

### Configure start commands with custom user

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/zerops-yaml/specification.mdx

Example showing how to create a system user in prepareCommands and use it in startCommands.

```yaml
run:
  prepareCommands:
    - sudo adduser --system --group --home /home/git git
  startCommands:
    - command: gitea web
      name: gitea
      user: git
```

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

### Start development server

Source: https://github.com/zeropsio/docs/blob/main/README.md

Commands to install project dependencies and launch the local development server at localhost:3001.

```bash
# Installs dependencies
yarn

# Starts the development server at localhost:3001
yarn dev
```

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

### ZCP quickstart prompts for the coding agent

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/static/llms-full.txt

Two example prompts for the ZCP quickstart. The first is a short, high-level request; the second adds product and stack details. Both are meant to be given to the coding agent in natural language.

```text
Build a task board for my team.
Tasks should stay saved after refresh.
```

```text
In this Laravel app, add a task board backed by the existing PostgreSQL service.
A user can create a task, refresh the page, and still see it.
```

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

### Set up environment and install dependencies

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/src/components/backup/frameworks/laravel/recipes/jetstream-local.mdx

Copy the environment file, install Composer dependencies, generate an application key, and install and build frontend assets. Fill in database access details from the Zerops GUI before running these commands.

```bash
# Create and configure environment file
cp .env.example .env
```

```bash
composer install
php artisan key:generate
npm install
npm run dev
```

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

### start command example

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/static/llms-small.txt

Required start command for the Node.js application. Uses npm start as recommended.

```yaml
zerops:
  # hostname of your service
  - setup: app
    # ==== how to build your application ====
    build: ...

    # ==== how to run your application ====
    run:
      # REQUIRED. Your Node.js application start command
      start: npm start

```

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

### deployFiles Basic Examples

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/deno/how-to/build-pipeline.mdx

Examples showing how to deploy specific files, folders, or the entire build container content.

```yaml
deployFiles:
  - dist
  - package.json
```

```yaml
deployFiles: .
```

```yaml
deployFiles:
  - ./path/to/file.txt
  - ./path/to/dir/
```

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

### Basic Java runtime customization

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/java/how-to/customize-runtime.mdx

Example of changing the base OS to Ubuntu and installing additional system packages using prepareCommands.

```yaml
run:
  os: ubuntu
  base: {{serviceVersion}
  prepareCommands:
    - sudo apk add imagemagick
```

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

### install in zerops.yaml

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/references/zsc.mdx

Example of using zsc install in a zerops.yaml prepareCommands section. The command installs python@3.11 in the runtime container.

```yaml
zerops:
  - setup: nodejsapp
    build:
      os: ubuntu
      base:
        - nodejs@22
        - python@3.11
    run:
      os: ubuntu
      base: nodejs@22
      prepareCommands:
        - zsc install python@3.11
```

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

### Basic Go runtime configuration

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/go/how-to/customize-runtime.mdx

This configuration demonstrates how to set the base OS to Ubuntu, install system packages like imagemagick, and install Go tools during the prepare phase.

```yaml
run:
  os: ubuntu
  base: 1.22
  prepareCommands:
    - sudo apt-get update
    - sudo apt-get install -y imagemagick
    - go install github.com/some/tool@latest
```

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

### Define multiple start commands

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/zerops-yaml/specification.mdx

Defines multiple commands that start their own processes, allowing for complex runtime setups.

```yaml
run:
  startCommands:
    # start the application
    - command: npm run start:prod
      name: server
    # start the replication
    - command: litestream replicate -config=litestream.yaml
      name: replication
      # restore the database on container init
      initCommands:
        - litestream restore -if-replica-exists -if-db-not-exists -config=litestream.yaml $DB_NAME
```

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

### Basic zerops.yaml configuration for PHP Apache service

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/static/llms-small.txt

This is the main zerops.yaml example. It defines one service with a setup hostname, build configuration using php-apache base, composer install, deployment of vendor and public folders, and a run configuration with a documentRoot and a custom site config file path. The base technology is required for build, and the run section is required in each service definition. All optional sections are provided as commented examples.

```yaml
zerops:
  # define hostname of your service
  - setup: app
    # ==== how to build your application ====
    build:
      # REQUIRED. Set the base technology for the build environment:
      base: php-apache@latest

      # OPTIONAL. Set the operating system for the build environment.
      # os: ubuntu

      # OPTIONAL. Customize the build environment by installing additional packages
      # or tools to the base build environment.
      # prepareCommands:
      #   - sudo apt-get something
      #   - curl something else

      # OPTIONAL. Build your application
      buildCommands:
        - composer install

      # REQUIRED. Select which files / folders to deploy after
      # the build has successfully finished
      deployFiles:
        - vendor
        - public

      # OPTIONAL. Which files / folders you want to cache for the next build.
      # Next builds will be faster when the cache is used.
      # cache: vendor

    # ==== how to run your application ====
    run:
      # OPTIONAL. Sets the base technology for the runtime environment:
      base: php-apache@latest

      # OPTIONAL. Customize the runtime PHP environment by installing additional
      # dependencies to the base PHP runtime environment.
      # prepareCommands:
      #   - sudo apt-get something
      #   - curl something else

      # OPTIONAL. Run one or more commands each time a new runtime container
      # is started or restarted. These commands are triggered before
      # your PHP application is started.
      # initCommands:
      #  - rm -rf ./cache

      # OPTIONAL. Customize the folder that will be used as the root of the publicly
      # accessible web server content. Enter the path relative to the /var/www folder.
      documentRoot: public

      # OPTIONAL. Sets the custom Nginx or Apache configuration. The file must be deployed in
      # the runtime container. Enter the path to the file relative to the /var/www folder
      siteConfigPath: site_config.tmpl

```

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

### start command example

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/rust/how-to/build-pipeline.mdx

Defines the required start command for the Rust application. This command is executed after initCommands and is used to launch the application.

```yaml
zerops:
  # hostname of your service
  - setup: app
    # ==== how to build your application ====
    build: ...

    # ==== how to run your application ====
    run:
      # REQUIRED. Your Rust application start command
      start: ./app
```

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

### Install additional technologies in runtime environment

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/deno/how-to/build-pipeline.mdx

Demonstrates how to define multiple base technologies as a YAML array and use prepareCommands to install extra tools like Go.

```yaml
zerops:
  # hostname of your service
  - setup: app
    # ==== how to build your application ====
    build:
      # REQUIRED. Sets the base technology for the build environment:
      base: deno@latest
      ...

    # ==== how to run your application ====
    run:
      # OPTIONAL. Sets the base technology for the runtime environment:
      base:
        - deno@latest
      prepareCommands:
        - zsc add go@latest
      ...
```

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

### start YAML example

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/static/llms-small.txt

Required start command for the Ruby application. Using bundle exec ensures vendored gems are used; the -b option makes Puma bind to all interfaces.

```yaml
zerops:
  # hostname of your service
  - setup: app
    # ==== how to build your application ====
    build: ...

    # ==== how to run your application ====
    run:
      # REQUIRED. Your Ruby application start command
      start: bundle exec puma -p 8080 -b tcp://0.0.0.0

```

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

### Python build commands example

Source: https://github.com/zeropsio/docs/blob/main/apps/docs/content/python/how-to/build-process.mdx

Example build commands for a Python application using pip and setup.py. The first command installs dependencies from requirements.txt with verbose output, and the second builds the package.

```yaml
buildCommands:
  - pip install -r requirements.txt --verbose
  - python setup.py build
```
Tokens:
Raw