Skip to content

Commit 7da04da

Browse files
committed
Replace emoji with plain text in architecture diagrams and add text language hint
1 parent c513c40 commit 7da04da

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ buildcage solves this by restricting outbound network access during builds to on
2222

2323
buildcage runs as a [remote driver](https://docs.docker.com/build/builders/drivers/remote/) for Docker Buildx. All `RUN` step containers are placed on an isolated network, and outbound traffic is routed through a proxy that enforces your allowlist.
2424

25-
```
25+
```text
2626
┌─ Docker Buildx (remote driver) ───────────────────────────┐
2727
│ │
2828
│ buildcage container │
@@ -34,8 +34,8 @@ buildcage runs as a [remote driver](https://docs.docker.com/build/builders/drive
3434
│ │ │ RUN step │───→│ Proxy (nginx) │ │ │
3535
│ │ │ (isolated net) │ │ │ │ │
3636
│ │ │ npm install, │ │ allowed domain? │ │ │
37-
│ │ │ apt-get, etc. │ │ → internet │ │ │
38-
│ │ └─────────────────┘ │ → blocked + logged│ │ │
37+
│ │ │ apt-get, etc. │ │ Yes → internet │ │ │
38+
│ │ └─────────────────┘ │ No → blocked+logged │ │ │
3939
│ │ └───────────────────────┘ │ │
4040
│ └─────────────────────────────────────────────────────┘ │
4141
└───────────────────────────────────────────────────────────┘
@@ -203,23 +203,22 @@ Starts the buildcage builder container.
203203
| `buildcage_image` | No | `ghcr.io/<owner>/<repo>` | Docker image name |
204204
| `buildcage_version` | No | `1` | Image tag |
205205
| `proxy_mode` | No | `restrict` | Operation mode (`audit` / `restrict`) |
206-
| `allowed_http_domains` | No | empty | Allowed HTTP domains (comma-separated, without port). See [Domain matching patterns](#domain-matching-patterns) below |
207-
| `allowed_https_domains` | No | empty | Allowed HTTPS domains (comma-separated, without port). See [Domain matching patterns](#domain-matching-patterns) below |
206+
| `allowed_http_domains` | No | empty | Allowed HTTP domains (comma-separated, without port) |
207+
| `allowed_https_domains` | No | empty | Allowed HTTPS domains (comma-separated, without port) |
208208
| `http_ports` | No | `80` | Comma-separated HTTP listen ports for the proxy |
209209
| `https_ports` | No | `443` | Comma-separated HTTPS listen ports for the proxy |
210210
| `port` | No | `1234` | BuildKit endpoint port on localhost |
211211

212-
##### Domain matching patterns
212+
**Domain matching patterns**
213213

214-
Domain values use nginx's [`map`](https://nginx.org/en/docs/http/ngx_http_map_module.html) directive with the `hostnames` parameter, supporting several patterns:
214+
The following patterns are supported for domain values:
215215

216216
| Pattern | Example | Matches |
217217
|---------|---------|---------|
218-
| Exact domain | `registry.npmjs.org` | Only `registry.npmjs.org` |
218+
| Exact domain | `www.example.com` | Only `www.example.com` |
219219
| Prefix wildcard | `*.example.com` | `sub.example.com`, `deep.sub.example.com` (not `example.com` itself) |
220220
| Dot-prefix shorthand | `.example.com` | Both `example.com` and `*.example.com` |
221221
| Suffix wildcard | `example.*` | `example.com`, `example.io`, `example.org`, etc. |
222-
| Regex | `~^.*\.amazonaws\.com$` | Full PCRE regex (prefix with `~`) |
223222

224223
#### Outputs
225224

@@ -332,7 +331,7 @@ buildcage creates a controlled network environment for your Docker builds:
332331

333332
### Architecture Diagram
334333

335-
```
334+
```text
336335
┌──────────────────────────────────────────────────────────────────┐
337336
│ Builder container (privileged, single container) │
338337
│ │

0 commit comments

Comments
 (0)