Starlight

https://github.com/zane-ops/docs
Admin
Starlight is an open-source documentation site generator built with Astro, designed for technical...
Tokens:34,853
Snippets:127
Trust Score:6.1
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Create ZaneOps Installation Directory

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Creates the directory where ZaneOps will be installed and navigates into it. The example uses `/var/www/zaneops`.

```shell
mkdir -p /var/www/zaneops 
cd /var/www/zaneops
```

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

### Run ZaneOps Setup

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Executes the setup process for ZaneOps using the downloaded Makefile. This step prepares the necessary files and configurations.

```shell
make setup
```

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

### Install ZaneOps

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/announcing-v1.mdx

This snippet provides the command-line instructions to install the ZaneOps CLI and set up the application. It involves creating a directory, downloading the Makefile, and running setup and deploy commands.

```shell
mkdir -p /var/www/zaneops && cd /var/www/zaneops

curl https://cdn.zaneops.dev/makefile > Makefile

make setup 

make deploy 
```

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

### ZaneOps Installation and Deployment

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/v1.9.mdx

Instructions for installing and deploying ZaneOps using shell commands. This includes fetching a Makefile and running setup and deploy commands.

```shell
# assuming you are at /var/www/zaneops
curl https://cdn.zaneops.dev/makefile > Makefile
make setup
make deploy
```

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

### Install ZaneOps via Shell

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/v1.10.mdx

Instructions for installing ZaneOps using shell commands, including downloading a Makefile and running setup and deploy commands.

```shell
# assuming you are at /var/www/zaneops
curl https://cdn.zaneops.dev/makefile > Makefile
make setup
make deploy
```

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

### Install ZaneOps via Shell

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/v1.11.mdx

Instructions for installing ZaneOps using shell commands, including downloading the Makefile and running setup and deploy commands.

```shell
# assuming you are at /var/www/zaneops
curl https://cdn.zaneops.dev/makefile > Makefile
make setup
make deploy
```

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

### Nixpacks.toml Configuration Example

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/nixpacks-builder.mdx

Provides an example of a nixpacks.toml file to customize build processes, including adding setup steps, defining linting phases, and modifying build commands.

```toml
# ./nixpacks.toml
[phases.setup]
 aptPkgs = ["...", "wget", "git"]   # Install git & wget packages with apt-get

[phases.lint] # add new `lint` step
 cmds = ["yarn run lint"]
dependsOn = ["install"]

[phases.build] 
dependsOn = ["...", "lint"] # build should come after `lint`
cmds = ["pnpm run db:generate && pnpm run build"]
```

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

### Development and Build Commands

Source: https://github.com/zane-ops/docs/blob/main/README.md

Provides a list of essential npm commands for managing an Astro project. This includes installing dependencies, starting a local development server, building the production site, and previewing the build.

```bash
npm install
npm run dev
npm run build
npm run preview
npm run astro ...
npm run astro -- --help
```

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

### ZaneOps Installation and Deployment

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/v1.7.mdx

Provides the shell commands to install ZaneOps by downloading a Makefile and running setup and deploy commands. Assumes the user is in the /var/www/zaneops directory.

```shell
# assuming you are at /var/www/zaneops
curl https://cdn.zaneops.dev/makefile > Makefile
make setup
make deploy
```

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

### Clone Guestbook Repository

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/tutorials/react-router.mdx

This snippet shows how to clone the example guestbook application repository from GitHub, which serves as the basis for the deployment guide.

```shell
git clone https://github.com/zane-ops/guestbook.git
```

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

### Configure ZaneOps Environment Variables

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Shows example environment variables in the `.env` file, specifically `ROOT_DOMAIN` and `ZANE_APP_DOMAIN`, which are crucial for setting up domain names for ZaneOps.

```shell
# /var/www/zaneops/.env
# ...other variables 
ROOT_DOMAIN="<YOUR-IP>.sslip.io" # Root domain for generating app subdomains
ZANE_APP_DOMAIN="<YOUR-IP>.sslip.io" # Domain for ZaneOps dashboard
```

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

### Nixpacks Environment Variables Example

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/nixpacks-builder.mdx

Demonstrates how to use environment variables to configure Nixpacks, such as installing apt packages and setting the Node.js version.

```shell
NIXPACKS_APT_PACKAGES="wget,git" # install wget & git with apt-get 
NIXPACKS_NODE_VERSION="22.x" # install node `22`
```

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

### Install Prerequisites (NixOS)

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Installs necessary command-line tools like make, curl, jq, and openssl on NixOS using nix-shell.

```shell
nix-shell -p gnumake curl jq openssl
```

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

### Deploy ZaneOps

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/troubleshooting.mdx

Example of the deployment process for ZaneOps, showing the initial deployment log output.

```shell
# make deploy
====== Deploying ZaneOps with HTTPS 🔒 ======
# other logs...
🏁 Deploy initiated
Waiting for all services to reach desired state, this should take less than 5 minutes... ◐
```

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

### Custom Caddyfile Example

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/nixpacks-builder.mdx

An example of a custom Caddyfile for serving static assets with caching, custom 404 handling, and using environment variables for port and root directory.

```ini
# ./Caddyfile
# expose your app to $PORT and use 80 if undefined
:{$PORT:80} {
    # Set the root directory for static files
    root * {$PUBLIC_ROOT}
    # Serve static files 
    file_server
    # Add `cache-control` header to static assets, images and videos
    @assets {
        path_regexp assets \.(css|js|png|jpg|jpeg|gif|svg|woff|woff2|eot|ttf|otf|mp4)$
    }
    header @assets Cache-Control "public, max-age=31536000, immutable"
    # For all 404 errors, show a custom page
    handle_errors {
        @404 {
            expression {http.error.status_code} == 404
        }
        rewrite @404 ./404/index.html
        file_server
    }
}
```

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

### Install ZaneOps

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/v1.8.mdx

Instructions for installing ZaneOps using curl and make commands. Assumes the current directory is /var/www/zaneops.

```shell
# assuming you are at /var/www/zaneops
curl https://cdn.zaneops.dev/makefile > Makefile
make setup
make deploy
```

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

### Install Prerequisites (Debian/Ubuntu)

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Installs necessary command-line tools like make, curl, jq, and openssl on Debian-based Linux distributions.

```shell
sudo apt install make curl jq openssl
```

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

### Install Prerequisites (Red Hat/Fedora)

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Installs necessary command-line tools like make, curl, jq, and openssl on Red Hat-based Linux distributions using dnf.

```shell
sudo dnf install -y make curl jq openssl
```

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

### Download ZaneOps Makefile

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Downloads the `Makefile` required for setting up and deploying ZaneOps from the specified CDN URL.

```shell
curl https://cdn.zaneops.dev/makefile > Makefile
```

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

### Install Prerequisites (macOS)

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Installs necessary command-line tools like make, curl, jq, and openssl on macOS using Homebrew.

```shell
brew install make curl jq openssl
```

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

### Install Prerequisites (Alpine Linux)

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Installs necessary command-line tools like make, curl, jq, and openssl on Alpine Linux using apk.

```shell
sudo apk add make curl jq openssl
```

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

### Create First ZaneOps User (CLI)

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Creates the initial user for the ZaneOps application via the command line interface.

```shell
make create-user
```

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

### Deploy ZaneOps

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Deploys the ZaneOps application using the `deploy` command from the Makefile.

```shell
make deploy
```

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

### Create Docker Service Steps

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/screenshots.mdx

A step-by-step visual guide for creating a Docker service in ZaneOps, with screenshots for each step in light and dark modes.

```image
https://assets.zaneops.dev/images/create-service-step1-light.png
```

```image
https://assets.zaneops.dev/images/create-service-step1-dark.png
```

```image
https://assets.zaneops.dev/images/create-service-step2-light.png
```

```image
https://assets.zaneops.dev/images/create-service-step2-dark.png
```

```image
https://assets.zaneops.dev/images/create-service-step3-light.png
```

```image
https://assets.zaneops.dev/images/create-service-step3-dark.png
```

```image
https://assets.zaneops.dev/images/create-service-step4-light.png
```

```image
https://assets.zaneops.dev/images/create-service-step4-dark.png
```

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

### Install Prerequisites (Arch Linux)

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Installs necessary command-line tools like make, curl, jq, and openssl on Arch Linux using pacman.

```shell
sudo pacman -S --noconfirm make curl jq openssl
```

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

### Starlight Components Usage

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Demonstrates the import of Starlight components like FileTree, Steps, and Aside within an Astro project, likely for documentation rendering.

```javascript
import {FileTree, Steps, Aside} from '@astrojs/starlight/components';
```

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

### Install Dependencies with Bun

Source: https://github.com/zane-ops/docs/blob/main/scripts/README.md

Installs project dependencies using the Bun package manager. Ensure Bun is installed on your system.

```bash
bun install
```

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

### Custom Caddyfile Example

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/railpack-builder.mdx

An example of a custom Caddyfile for serving static assets with caching, custom 404 handling, and using environment variables for root directory and port.

```ini
# ./Caddyfile
# expose your app to $PORT and use 80 if undefined
:{$PORT:80} {
    # Set the root directory for static files
    root * {$PUBLIC_ROOT}
    # Serve static files 
    file_server
    # Add `cache-control` header to static assets, images and videos
    @assets {
        path_regexp assets \.(css|js|png|jpg|jpeg|gif|svg|woff|woff2|eot|ttf|otf|mp4)$
    }
    header @assets Cache-Control "public, max-age=31536000, immutable"
    # For all 404 errors, show a custom page
    handle_errors {
        @404 {
            expression {http.error.status_code} == 404
        }
        rewrite @404 ./404/index.html
        file_server
    }
}
```

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

### Project Creation Screenshots

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/screenshots.mdx

Visual guide to creating a new project in ZaneOps, with screenshots for both light and dark modes.

```image
https://assets.zaneops.dev/images/create-project-light.png
```

```image
https://assets.zaneops.dev/images/create-project-dark.png
```

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

### Initialize Docker Swarm

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Initializes a Docker Swarm cluster. Replace `<MANAGER_IP>` with the server's IP address (public, private, or 127.0.0.1 for local installs).

```shell
docker swarm init --advertise-addr <MANAGER_IP>
```

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

### Local Installation Configuration

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Configures ZaneOps for local installation by setting environment variables for the application domain, root domain, and HTTP mode. Includes commands to stop, deploy, and access the ZaneOps dashboard locally.

```shell
# /var/www/zaneops/.env
# ... other env variables
ZANE_APP_DOMAIN="127-0-0-1.sslip.io"
ROOT_DOMAIN="127-0-0-1.sslip.io"
MODE=http
__DANGEROUS_ALLOW_HTTP_SESSION="true"

make stop
make deploy

# Access at http://127-0-0-1.sslip.io
```

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

### Custom Caddyfile Example

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/static-dir-builder.mdx

An example of a custom Caddyfile for the static directory builder. This configuration exposes the app to a specified port, sets the static file root, serves files, adds cache-control headers for assets, and handles 404 errors by rewriting to a custom index page.

```ini
# ./Caddyfile
# expose your app to $PORT and use 80 if undefined
:{$PORT:80} {
    # Set the root directory for static files
    root * {$PUBLIC_ROOT}
    # Serve static files 
    file_server
    # Add `cache-control` header to static assets, images and videos
    @assets {
        path_regexp assets \.(css|js|png|jpg|jpeg|gif|svg|woff|woff2|eot|ttf|otf|mp4)$    }
    header @assets Cache-Control "public, max-age=31536000, immutable"
    # For all 404 errors, show a custom page
    handle_errors {
        @404 {
            expression {http.error.status_code} == 404
        }
        rewrite @404 ./404/index.html
        file_server
    }
}
```

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

### Health Check Command Example

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/zero-downtime-deploys.mdx

Example of configuring a health check using a command. ZaneOps will execute the command and ensure it exits with code 0.

```bash
service.healthCheck.command = 'npm run healthcheck';
```

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

### Creating Git Services

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/screenshots.mdx

Guides users through the process of creating Git services, with visuals for the creation page in light and dark modes.

```APIDOC
Feature: Creating Git Services
Description: Workflow for creating new Git services.
Visuals:
- Creation Page (Light): https://assets.zaneops.dev/images/create-git-service-light.png
- Creation Page (Dark): https://assets.zaneops.dev/images/create-git-service-dark.png
```

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

### Environment Variables Explained

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/installation.mdx

Details the purpose and usage of various environment variables for ZaneOps configuration, including versioning, directory paths, database credentials, security keys, domain settings, and operational modes.

```text
1. IMAGE_VERSION: Specifies the ZaneOps version to install.
2. ZANE_APP_DIRECTORY: Defines the directory where ZaneOps will be installed.
3. ZANE_DB_USER / ZANE_DB_PASSWORD: Credentials for connecting to the database.
4. DJANGO_SECRET_KEY: Used by the API for various security functions, such as hashing user session tokens. Generate a secure key with at least 64 characters using a tool like openssl (e.g., openssl rand -base64 64).
5. ROOT_DOMAIN: Used to generate subdomains for deployed web apps, e.g., my-web-app.127-0-0-1.sslip.io. The root domain itself can also host the dashboard if desired.
6. ZANE_APP_DOMAIN: The domain where the ZaneOps dashboard will be accessible after deployment. It can be the same as ROOT_DOMAIN
7. MODE : the mode in which to deploy your zaneops instance, should be either https or http, if you change this to http, it enables the port 80 on your instance, beware as it can be source of security vulnerabilities.
8. __DANGEROUS_ALLOW_HTTP_SESSION : allow for authenticating to zaneops using a domain on http://
```

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

### GitHub Actions Workflow for Deployment

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/tutorials/react-router.mdx

Automates the build and deployment process of the guestbook application. This workflow triggers on pushes to the main branch and uses a webhook to deploy changes to ZaneOps.

```yaml
# .github/workflows/ci.yaml
name: Deploy
on:
  push:
    branches: [main] # customize as needed
jobs:
  build-push-app:
    name: Build and Deploy Guestbook
    runs-on: ubuntu-latest
    steps:
        - name: Checkout
          uses: actions/checkout@v4
        - name: Deploy to ZaneOps
          run: curl -f -o /dev/null -X PUT "${{ secrets.DEPLOY_WEBHOOK_URL }}"
```

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

### Bun Service Start Command

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/tutorials/bun-function.mdx

This command is used to start a Bun service. It executes a TypeScript file located at `/app/index.ts` using the `bun run` command.

```shell
bun run /app/index.ts
```

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

### Import Starlight Components

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/environments.mdx

Imports necessary components from the Starlight library for building documentation pages, specifically for creating step-by-step guides and side notes.

```astro
import {Steps, Aside} from '@astrojs/starlight/components';
```

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

### Verifying DNS Records

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/configuring-zaneops.mdx

Demonstrates how to verify DNS record propagation using command-line tools. It provides examples for both `dig` and `nslookup` to check the A record for a given domain.

```shell
# Using `dig`
dig +short admin.zaneops.dev A

# Using `nslookup`
nslookup admin.zaneops.dev
```

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

### Run Project Script with Bun

Source: https://github.com/zane-ops/docs/blob/main/scripts/README.md

Executes the main project script 'index.ts' using the Bun runtime. This command assumes dependencies are already installed.

```bash
bun run index.ts
```

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

### Valkey (Redis) Docker Service Configuration

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/tutorials/react-router.mdx

This snippet outlines the basic Docker service configuration for running Valkey, an open-source Redis alternative, which is used for caching in the guestbook application.

```dockerfile
FROM valkey/valkey
```

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

### Project Structure Overview

Source: https://github.com/zane-ops/docs/blob/main/README.md

Illustrates the typical directory and file structure of an Astro project utilizing the Starlight framework. Key directories include `public/` for static assets and `src/content/docs/` for documentation files.

```bash
.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```

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

### Create Starlight Project

Source: https://github.com/zane-ops/docs/blob/main/README.md

This command initiates the creation of a new Astro project pre-configured with the Starlight template. It's the first step in setting up a documentation site with Starlight.

```bash
npm create astro@latest -- --template starlight
```

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

### Bun Project Initialization

Source: https://github.com/zane-ops/docs/blob/main/scripts/README.md

Demonstrates the command used to initialize a new project with Bun, highlighting the Bun version used.

```bash
bun init
```

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

### Railpack Environment Variables Configuration

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/railpack-builder.mdx

Examples of environment variables that can be used to configure the Railpack builder, such as installing specific packages or setting language runtime versions.

```shell
RAILPACK_DEPLOY_APT_PACKAGES="wget,git" # install wget & git with apt-get and persist it at build time
RAILPACK_BUN_VERSION=" 1.2.10" # install bun `1.2.10`
```

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

### Health Check Path Example

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/zero-downtime-deploys.mdx

Example of configuring a health check using a specific path. ZaneOps will monitor the specified endpoint for a successful status code (2xx).

```javascript
service.healthCheck.path = '/health';
service.healthCheck.method = 'GET';
```

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

### Onboarding Screenshots

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/screenshots.mdx

Screenshots of the ZaneOps onboarding process, showing the user creation form in both light and dark modes.

```image
https://assets.zaneops.dev/images/create-user-light.png
```

```image
https://assets.zaneops.dev/images/create-user-dark.png
```

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

### Astro Starlight Component Usage

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/v1.10.mdx

Example of using the Aside component from '@astrojs/starlight/components' in an Astro project.

```javascript
import {Aside} from '@astrojs/starlight/components';
```

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

### Environment Variable Usage

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/changelog/v1.11.mdx

Example of importing and using an environment variable for an assets server domain in Astro.

```javascript
import { ASSETS_SERVER_DOMAIN } from "astro:env/client"

<img className="block dark:hidden" src={`${ASSETS_SERVER_DOMAIN}/images/new-version-toast-light.png`} alt="clone environment modal" />
<img className="!hidden dark:!block" src={`${ASSETS_SERVER_DOMAIN}/images/new-version-toast-dark.png`} alt="clone environment modal" />
```

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

### Perform Authorized Request

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/api-reference/authentication.mdx

This snippet shows how to make an authorized GET request to the `/api/auth/me` endpoint using the previously obtained session cookie.

```http
### Request
GET /api/auth/me HTTP/1.1
Cookie: sessionid=tvmt1xp0c2ep33htukqm140fb4igkz4u;

### Response
HTTP/1.1 201 Created
Content-Type: application/json

{
  "user": {
    "username": "fredkiss3",
    "first_name": "",
    "last_name": ""
  }
}
```

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

### Aside Component Usage

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/index.mdx

Demonstrates how to use the Aside component from '@astrojs/starlight/components' to display cautionary notes within the documentation.

```javascript
import {Aside} from '@astrojs/starlight/components';

<Aside type="caution" title='Docker build resource usage'>
  The Docker build process can consume up to 100% of your server's resources, potentially slowing it to a crawl.
  Make sure your server is powerful enough to handle it.

  ZaneOps will try to limit the resource usage of the build process to **~33%** to avoid that, but 
  it is not guaranteed to work for every builder.
</Aside>
```

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

### Inspect ZaneOps Service Tasks

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/troubleshooting.mdx

Command to inspect the tasks of a specific ZaneOps Docker service to check their status. It provides an example of the expected output when a task is running.

```shell
docker service ps zane_{service} # ex: `zane_app`
```

```shell
ID             NAME             IMAGE                       NODE    DESIRED STATE   CURRENT STATE   ERROR 
7b21smevkj6l   zane_app.1       ghcr.io/zane-ops/app:canary   ubs01   Running         Running 2 hours ago 
ppfheeofce3t    _ zane_app.1   ghcr.io/zane-ops/app:canary   ubs01   Shutdown        Shutdown 2 hours ago
```

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

### Obtain CSRF Token

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/api-reference/authentication.mdx

This snippet demonstrates how to obtain a CSRF token by making a GET request to the `/api/csrf` endpoint. The response includes a `Set-Cookie` header with the `csrftoken`.

```http
### Request
GET /api/csrf HTTP/1.1

### Response
HTTP/1.1 200 OK

Set-Cookie: csrftoken=zydcEbNXQGJFxzLphKEO8Mg88VdEwi8c; expires=Wed, 09 Jul 2025 17:03:09 GMT; Max-Age=31449600; Path=/; SameSite=Lax
```

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

### Dockerfile Builder Configuration

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/dockerfile-builder.mdx

Configuration options for building Docker images using a Dockerfile. This includes specifying the build context directory, the path to the Dockerfile, and an optional build stage target for multi-stage builds.

```markdown
- You can specify a **build context directory** for where the dockerfile should build your application, relative to the root of your repository
- You can specify the path of your **Dockerfile**, relative to the root of your repository
- And you can specify a **Docker build stage target** if you build your image using a multi-stage build and want to stop at a certain step of the build
```

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

### Builders Overview Markdown

Source: https://github.com/zane-ops/docs/blob/main/src/content/docs/knowledge-base/Builders/index.mdx

Markdown content detailing the purpose and types of ZaneOps Builders, including links to related concepts and a caution about resource usage.

```markdown
> Introduced in [**v1.8.0**](/changelog/v18)

Builders are tools used to package [Git services](/knowledge-base/git) into deployable containers.
They either detect or generate a **Dockerfile**, then build your application using `docker build`.

Supported builders include:
- [Nixpacks](./nixpacks-builder)
- [Railpack](./railpack-builder)
- [Dockerfile](./dockerfile-builder)
- [Static directory](./static-dir-builder)

#### Accessing other services

When building your application, all the services from the same project are available, you can reference them using their network alias.
```
Tokens:
Raw