You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/introduction/getting_started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ my-project/
60
60
└── docker-compose.yml
61
61
```
62
62
63
-
Each application (`app1`, `app2`, `app3`) has its own folder containing one or more Compose files and optional configuration. The `dockform.yml` manifest ties everything together.
63
+
Each stack (`app1`, `app2`, `app3`) has its own folder containing one or more Compose files and optional configuration. The `dockform.yml` manifest ties everything together.
Copy file name to clipboardExpand all lines: docs/introduction/what_is_dockform.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: What is Dockform?
5
5
# What is Dockform?
6
6
7
7
Dockform extends Docker Compose with a fully declarative workflow.
8
-
It lets you manage not only your Compose applications, but also the supporting resources that normally sit outside of `docker-compose.yml` — such as external networks, volume lifecycles, secrets, and configuration files.
8
+
It lets you manage not only your Compose stacks, but also the supporting resources that normally sit outside of `docker-compose.yml` — such as external networks, volume lifecycles, secrets, and configuration files.
9
9
10
10
Think of Dockform as the missing declarative layer for everything you’d otherwise configure manually with commands like `docker network create`, `docker volume create`, or ad-hoc shell scripts. All of it is written as code, stored in a manifest, and applied consistently.
| SSL certificates | `hot` | Most apps can reload certs |
169
-
| Application binaries | `cold` | Files must not change while running |
169
+
| Stack binaries | `cold` | Files must not change while running |
170
170
171
171
## Restart targets
172
172
@@ -221,7 +221,7 @@ When `preserve_existing` is enabled, existing files keep their prior owner and m
221
221
::: code-group
222
222
223
223
```yaml [dockform.yaml]
224
-
applications:
224
+
stacks:
225
225
web:
226
226
root: ./web
227
227
project:
@@ -259,14 +259,14 @@ volumes:
259
259
- Run `dockform plan` to preview volume creation and fileset changes.
260
260
- Run `dockform apply` to sync files, start/update services, and restart any listed services.
261
261
262
-
## Example: application requiring cold updates
262
+
## Example: stack requiring cold updates
263
263
264
-
Some applications require that configuration files are only updated when the container is stopped. For example, certain media management tools or databases that lock configuration files:
264
+
Some stacks require that configuration files are only updated when the container is stopped. For example, certain media management tools or databases that lock configuration files:
Copy file name to clipboardExpand all lines: docs/manifest/overview.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ outline: deep
5
5
6
6
# The Manifest File
7
7
8
-
A Dockform manifest is a single YAML file that defines all resources needed for a Compose project. With it, you can declare applications, environment variables, secrets, volumes, networks, and filesets in one place, making your stack fully reproducible and declarative.
8
+
A Dockform manifest is a single YAML file that defines all resources needed for a Compose project. With it, you can declare stacks, environment variables, secrets, volumes, networks, and filesets in one place, making your stack fully reproducible and declarative.
9
9
10
10
## Overview
11
11
@@ -34,7 +34,7 @@ secrets:
34
34
sops:
35
35
- secrets.env
36
36
37
-
applications:
37
+
stacks:
38
38
web:
39
39
root: ./web
40
40
files:
@@ -108,9 +108,9 @@ Dockform uses this string to label and group all managed resources.
108
108
109
109
## Environment Variables
110
110
111
-
You can define global or app-specific environment variables. Variables declared at the root level apply to all applications. Variables under `applications.<app>.environment` are scoped to that application only.
111
+
You can define global or stack-specific environment variables. Variables declared at the root level apply to all stacks. Variables under `stcks.<app>.environment` are scoped to that stack only.
112
112
113
-
> In case of conflict, application-specific variables override global variables.
113
+
> In case of conflict, stack-specific variables override global variables.
114
114
115
115
::: code-group
116
116
@@ -124,7 +124,7 @@ environment:
124
124
```
125
125
126
126
```yaml [Scoped]
127
-
applications:
127
+
stacks:
128
128
web:
129
129
environment:
130
130
files:
@@ -150,9 +150,9 @@ Array of `KEY=VALUE` entries declared directly in the manifest.
150
150
151
151
## Secrets
152
152
153
-
Secrets can also be global or app-specific. Root-level secrets are exposed to all applications, while `applications.<app>.secrets` only apply to that app.
153
+
Secrets can also be global or app-specific. Root-level secrets are exposed to all stacks, while `stacks.<app>.secrets` only apply to that app.
154
154
155
-
> In case of conflict, application-specific secrets override global ones.
155
+
> In case of conflict, stack-specific secrets override global ones.
156
156
157
157
Secrets are managed with [SOPS](https://github.com/getsops/sops). Dockform supports both **Age** and **PGP (GnuPG)** backends. See [Secrets Workflow](secrets/secrets) for details.
158
158
@@ -173,7 +173,7 @@ secrets:
173
173
```
174
174
175
175
```yaml [Scoped]
176
-
applications:
176
+
stacks:
177
177
web:
178
178
secrets:
179
179
sops:
@@ -209,15 +209,15 @@ Name of a Docker [named volume](https://docs.docker.com/engine/storage/volumes/)
209
209
210
210
Name of a Docker [network](https://docs.docker.com/reference/cli/docker/network/create/).
211
211
212
-
## Applications
212
+
## Stacks
213
213
214
-
The `applications` block is where all Docker Compose configurations converge.
214
+
The `stacks` block is where all Docker Compose configurations converge.
Copy file name to clipboardExpand all lines: docs/manifest/volumes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ In this example, the `traefik_config` volume will be created if missing, even if
71
71
- **apply**:
72
72
- Lists existing labeled volumes and creates any missing ones from `volumes:` and `filesets.target_volume`.
73
73
- Labels volumes with `io.dockform.identifier=<docker.identifier>`.
74
-
- Proceeds to sync filesets and run `docker compose up` for applications.
74
+
- Proceeds to sync filesets and run `docker compose up` for stacks.
75
75
- **destroy**: discovers all labeled resources for the current identifier and removes them, including volumes (fileset volumes first, then standalone).
0 commit comments