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
{{ message }}
Repository navigation
Commit 421b39f
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,14 @@ The `install` command auto-detects all installed coding agents and configures MC
104
104
105
105
### Graph Visualization UI
106
106
107
-
If you downloaded the `ui` variant:
107
+
The UI ships as a separate `ui` build (it embeds the frontend). The default install on every channel is the lean, headless server; opt into the UI build with:
108
+
109
+
-**install.sh:** add `--ui` (see [Quick Start](#quick-start))
|`CBM_ALLOWED_ROOT`|*(unset)*| Restrict `index_repository` to paths within this directory. When set, a `repo_path` that resolves (after symlink / `..` resolution) outside this root is refused; unset imposes no restriction. Useful when the server may be driven by an untrusted caller, e.g. agentic or multi-tenant deployments. |
479
487
|`CBM_CACHE_DIR`|`~/.cache/codebase-memory-mcp`| Override the database storage directory. All project indexes and config are stored here. |
480
488
|`CBM_DIAGNOSTICS`|`false`| Set to `1` or `true` to enable periodic diagnostics output to `/tmp/cbm-diagnostics-<pid>.json`. |
481
489
|`CBM_DOWNLOAD_URL`|*(GitHub releases)*| Override the download URL for updates. Used for testing or self-hosted deployments. |
Copy file name to clipboardExpand all lines: SECURITY.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
codebase-memory-mcp interacts deeply with your filesystem. It reads source files across your entire codebase, writes to agent configuration files, and spawns background processes. This is inherent to what it does — not a bug.
6
6
7
-
**If you are uncomfortable with these access patterns**, please audit the source code before running. The full source is available in this repository. Every release binary is reproducibly built from this source and can be independently verified via SLSA provenance, Sigstore signatures, and SHA-256 checksums (see [Verification](#verification) below).
7
+
**If you are uncomfortable with these access patterns**, please audit the source code before running. The full source is available in this repository. Release binaries produced by the current release pipeline are verifiably built from this source and can be independently verified via SLSA Build Level 3 provenance, Sigstore signatures, and SHA-256 checksums (see [Verification](#verification) below).
8
8
9
9
We are humans and can make mistakes. We take security seriously — it is Priority #1 for this project — but we cannot guarantee perfection. By using this software you accept responsibility for evaluating whether it meets your own security requirements.
10
10
@@ -122,13 +122,21 @@ This project implements multiple layers of security verification. Every release
122
122
123
123
Releases are created as **drafts** (invisible to users) and only published after all verification passes:
124
124
125
-
1.**SLSA build provenance** — cryptographic attestation proving each binary was built by GitHub Actions from this repository
125
+
1.**SLSA Build Level 3 provenance for release binaries** — cryptographic attestation generated inside the trusted GitHub Actions build workflow immediately after each release archive is produced
126
126
2.**Sigstore cosign signing** — keyless digital signatures verifiable by anyone
127
-
3.**SBOM** — Software Bill of Materials (CycloneDX) listing all vendored dependencies
127
+
3.**SBOM** — Software Bill of Materials (SPDX) listing all vendored dependencies
128
128
4.**SHA-256 checksums** — published with every release
129
129
5.**VirusTotal scanning** — all binaries scanned by 70+ antivirus engines (zero-tolerance: any detection blocks the release)
130
130
6.**OpenSSF Scorecard** — repository security health score
131
131
132
+
Scope of the SLSA claim: this is a build provenance claim for release
133
+
artifacts. It proves the attested archive was produced by the repository's
134
+
trusted GitHub-hosted build workflow from repository source. It is not
135
+
third-party certification, it is not retroactive to older releases, and it does
136
+
not mean the source code is vulnerability-free or that maintainers cannot change
137
+
source. Consumers should verify the signer workflow, not only repository
138
+
ownership.
139
+
132
140
If ANY antivirus engine flags ANY binary, the release stays as a draft and is not published until the issue is investigated and resolved.
133
141
134
142
### Code-Level Defenses
@@ -145,8 +153,10 @@ If ANY antivirus engine flags ANY binary, the release stays as a draft and is no
145
153
Users can independently verify any release binary:
146
154
147
155
```bash
148
-
# SLSA provenance (proves binary came from this repo's CI)
Copy file name to clipboardExpand all lines: docs/CONFIGURATION.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,6 +110,7 @@ These environment variables affect runtime behavior:
110
110
111
111
| Variable | Default | Description |
112
112
|---|---|---|
113
+
|`CBM_ALLOWED_ROOT`|*(unset)*| Restrict `index_repository` to paths within this directory. When set, a `repo_path` that resolves (after symlink / `..` resolution) outside this root is refused; unset imposes no restriction. Useful when the server may be driven by an untrusted caller (agentic or multi-tenant deployments). |
113
114
|`CBM_CACHE_DIR`|`~/.cache/codebase-memory-mcp`| Override the cache directory used for indexes, `_config.db`, and UI `config.json`. |
114
115
|`CBM_DIAGNOSTICS`|`false`| Enable periodic diagnostics output to `/tmp/cbm-diagnostics-<pid>.json`. |
115
116
|`CBM_DOWNLOAD_URL`| GitHub releases | Override the update download URL. |
0 commit comments