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/ai-coder/agent-boundary.md
+65-11Lines changed: 65 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,32 +16,86 @@ Agent Boundaries offer network policy enforcement, which blocks domains and HTTP
16
16
17
17
The easiest way to use Agent Boundaries is through existing Coder modules, such as the [Claude Code module](https://registry.coder.com/modules/coder/claude-code). It can also be ran directly in the terminal by installing the [CLI](https://github.com/coder/boundary).
18
18
19
-
Below is an example of how to configure Agent Boundaries for usage in your workspace.
19
+
There are two supported ways to configure Boundary today:
20
+
21
+
1.**Inline module configuration** – fastest for quick testing.
22
+
2.**External `config.yaml`** – best when you need a large allow list or want everyone who launches Boundary manually to share the same config.
Boundary automatically reads `config.yaml` from `~/.config/coder_boundary/` when it starts, so everyone who launches Boundary manually inside the workspace picks up the same configuration without extra flags. This is especially convenient for managing extensive allow lists in version control.
86
+
87
+
- `boundary_version`defines what version of Boundary is being applied. This is set to `v0.2.0`, which points to the v0.2.0 release tag of `coder/boundary`.
35
88
- `boundary_log_dir`is the directory where log files are written to when the workspace spins up.
36
89
- `boundary_log_level` defines the verbosity at which requests are logged. Boundary uses the following verbosity levels:
37
90
- `WARN`: logs only requests that have been blocked by Boundary
38
91
- `INFO`: logs all requests at a high level
39
92
- `DEBUG`: logs all requests in detail
40
-
-`boundary_additional_allowed_urls`: defines the URLs that the agent can access, in additional to the default URLs required for the agent to work
41
-
-`github.com` means only the specific domain is allowed
42
-
-`*.github.com` means only the subdomains are allowed - the specific domain is excluded
43
-
-`*github.com` means both the specific domain and all subdomains are allowed
44
-
- You can also also filter on methods, hostnames, and paths - for example, `GET,HEAD *github.com/coder`.
93
+
- `boundary_additional_allowed_urls`: defines the URLs that the agent can access, in addition to the default URLs required for the agent to work. Rules use the format `"key=value [key=value ...]"`:
94
+
- `domain=github.com`- allows the domain and all its subdomains
95
+
- `domain=*.github.com`- allows only subdomains (the specific domain is excluded)
96
+
- `method=GET,HEAD domain=api.github.com`- allows specific HTTP methods for a domain
97
+
- `method=POST domain=api.example.com path=/users,/posts`- allows specific methods, domain, and paths
98
+
- `path=/api/v1/*,/api/v2/*`- allows specific URL paths
45
99
46
100
You can also run Agent Boundaries directly in your workspace and configure it per template. You can do so by installing the [binary](https://github.com/coder/boundary) into the workspace image or at start-up. You can do so with the following command:
0 commit comments