Skip to content

z0 - startCommands user #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tikinang merged 1 commit into from
Sep 3, 2026
Merged

z0 - startCommands user #373

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions apps/docs/content/zerops-yaml/specification.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,24 @@ run:
- litestream restore -if-replica-exists -if-db-not-exists -config=litestream.yaml $DB_NAME
```

Each entry supports:

- `command` (required) - the command to run
- `name` (optional) - distinguishes the process in logs
- `workingDir` (optional, default `/var/www`) - the directory the command and its `initCommands` run in
- `user` (optional, default `zerops`) - the system user the command and its `initCommands` run under. The user has to exist in the runtime container, create it in `prepareCommands`.
- `initCommands` (optional) - commands run before this process starts, each time a container starts or restarts

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

See [start-commands-example](https://github.com/zeropsio/start-commands-example)

### documentRoot <Badge type="optional" />
Expand Down Expand Up @@ -492,6 +510,10 @@ Files or directories to process for variable replacement.
Directory targets only process files directly in the specified directory, not subdirectories for performance reasons. To process files in subdirectories, specify each subdirectory explicitly in the target array. For example, ./config/ processes only files in the config directory itself, not files in ./config/jwt/ or other subdirectories.
:::

:::info
Not to be confused with the [`zsc env-replace`](/references/zsc#env-replace) command, which renders `{{.VARIABLE}}` Go templates from a source path into a separate target path and can be run from `initCommands` or manually.
:::

**How it works:**
1. Define placeholders in your files using the specified delimiters
2. Set environment variables with matching names
Expand Down
Loading