Skip to content

Commit df94693

Browse files
authored
Merge pull request #10 from dash14/docs/add-trust-and-self-hosting-section
Add Trust & Self-Hosting section to README
2 parents 0d39de1 + a17cc65 commit df94693

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ buildcage runs as a [remote driver](https://docs.docker.com/build/builders/drive
6464
- 🔍 **Audit mode**: Discover dependencies before enforcing restrictions
6565
- 🛡️ **Restrict mode**: Production-ready access control
6666
- 📊 **Detailed logging**: Complete visibility into all network connections during builds
67+
- 🔐 **Self-hostable**: Fork or import the repo to build and manage the image in your own GitHub environment — full control over what you trust
6768

6869
## Quick Start
6970

@@ -325,6 +326,28 @@ All containers spawned by BuildKit `RUN` steps are placed on an isolated network
325326

326327
---
327328

329+
## Trust & Self-Hosting
330+
331+
buildcage is a security tool — so it's fair to ask: *how do you trust buildcage itself?*
332+
333+
A pre-built image from a third party could be modified or rebuilt at any time without your knowledge. For a tool that sits in your build pipeline, that's a risk worth addressing.
334+
335+
**Self-hosting (recommended for production)**
336+
337+
You can fork or import this repository into your own GitHub organization, review the source code, and build the Docker image entirely within your own infrastructure. This gives you:
338+
339+
- Full visibility into what the tool contains
340+
- Control over when and how updates are applied
341+
- A reproducible, tamper-proof build artifact that you own
342+
343+
See the [Self-Hosting Guide](./docs/self-hosting.md) for setup instructions.
344+
345+
**Using the upstream image**
346+
347+
If you don't need that level of control, you can use the image published from this repository directly. This is the simplest option and keeps you up to date with the latest fixes and improvements automatically.
348+
349+
---
350+
328351
## Security Considerations
329352

330353
> **Important:** buildcage controls *where* your builds can connect, not *what code* they run. If a malicious package is delivered through a legitimate repository (e.g., a compromised npm package hosted on `registry.npmjs.org`), buildcage cannot detect or prevent it — the connection goes to an allowed domain.
@@ -353,7 +376,7 @@ The only known bypass is **domain fronting** — a technique where an attacker s
353376

354377
- **Can I host buildcage in my own private repository?**
355378

356-
Yes. You can import the repository into your organization and build the Docker image yourself. See the [Self-Hosting Guide](./docs/self-hosting.md) for details.
379+
Yes. See [Trust & Self-Hosting](#trust--self-hosting) for details.
357380

358381
- **Does this slow down my builds?**
359382

0 commit comments

Comments
 (0)