openso/crowdsec-agent
Watch
1
0
Fork
You've already forked crowdsec-agent
 0
Code Issues Pull requests Packages 1 Activity Actions

docs: use short volume syntax in README compose example #3

Merged
MHE merged 1 commit from explain-long-volume-syntax into main 2026-11-01 14:37:42 +01:00
Conversation 0 Commits 1 Files changed 1 +3 -10
MHE commented 2026-11-01 14:35:47 +01:00
Owner
Copy link

What changed

The volumes section of the crowdsec-agent service example in README.md now uses the short source:target:mode syntax instead of the long type/source/target/read_only form.

  • crowdsec_agent_data named volume mounted at /var/lib/crowdsec/data (rw)
  • ./appdata/crowdsec_agent/config bind-mounted at /etc/crowdsec (rw)
  • ./appdata/logs bind-mounted read-only at /var/log/appdata (ro)

Why

The short syntax is more compact and easier to scan in a compose example, and it expresses the same mounts and access modes. Behaviour of the documented setup is unchanged.

## What changed The `volumes` section of the `crowdsec-agent` service example in `README.md` now uses the short `source:target:mode` syntax instead of the long `type/source/target/read_only` form. - `crowdsec_agent_data` named volume mounted at `/var/lib/crowdsec/data` (rw) - `./appdata/crowdsec_agent/config` bind-mounted at `/etc/crowdsec` (rw) - `./appdata/logs` bind-mounted read-only at `/var/log/appdata` (ro) ## Why The short syntax is more compact and easier to scan in a compose example, and it expresses the same mounts and access modes. Behaviour of the documented setup is unchanged.
Simplify volume syntax in README compose example
All checks were successful
ci / compose (pull_request) Successful in 12s
Details
ci / shellcheck (pull_request) Successful in 2s
Details
ci / conventions (pull_request) Successful in 2s
Details
ci / image (pull_request) Successful in 30s
Details
fade90b8bd
MHE merged commit 60fd0ecb87 into main 2026-11-01 14:37:42 +01:00
MHE deleted branch explain-long-volume-syntax 2026-11-01 14:37:53 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
openso/crowdsec-agent!3
No description provided.