Every agent's model. One place. Codex on DeepSeek, Claude Code on Kimi, from the menu bar.
docs: a privacy masking how-to in en, zh and ja, linked from every docs page
yetoned153f025936b
diff --git a/site/public/docs/docker.html b/site/public/docs/docker.htmlindex 4410ef694..894dd81b1 100644--- a/site/public/docs/docker.html+++ b/site/public/docs/docker.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -219,6 +220,7 @@ docker logs magpie</pre><a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/import.html b/site/public/docs/import.htmlindex cf58e2130..8271b3ba2 100644--- a/site/public/docs/import.html+++ b/site/public/docs/import.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -263,6 +264,7 @@ href = <span class="s">"https://usemagpie.ai/import#"</span> + urlencode({<a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="https://github.com/yetone/magpie">GitHub</a><a href="https://discord.gg/vGSnD3ZKQF">Discord</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>diff --git a/site/public/docs/integrate.html b/site/public/docs/integrate.htmlindex 1ff43e88a..100212f15 100644--- a/site/public/docs/integrate.html+++ b/site/public/docs/integrate.html@@ -48,6 +48,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -154,6 +155,7 @@ curl -s http://127.0.0.1:3425/v1/models -H "Authorization: Bearer magpie-acme"</<a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/intent.html b/site/public/docs/intent.htmlindex b8ffaee48..536bcc7dc 100644--- a/site/public/docs/intent.html+++ b/site/public/docs/intent.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -326,6 +327,7 @@ The number of its kind (0 for none):</pre><a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/ja/docker.html b/site/public/docs/ja/docker.htmlindex 20457ef44..8d9d2d93a 100644--- a/site/public/docs/ja/docker.html+++ b/site/public/docs/ja/docker.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/ja/remote">リモート magpie</a><a class="toc-only" href="/docs/ja/docker">Docker</a><a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>@@ -219,6 +220,7 @@ docker logs magpie</pre><a href="/docs/ja/remote">リモート magpie</a><a href="/docs/ja/docker">Docker</a><a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/ja/import.html b/site/public/docs/ja/import.htmlindex 9d865a5e0..0b5ee7bfd 100644--- a/site/public/docs/ja/import.html+++ b/site/public/docs/ja/import.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/ja/remote">リモート magpie</a><a class="toc-only" href="/docs/ja/docker">Docker</a><a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>@@ -263,6 +264,7 @@ href = <span class="s">"https://usemagpie.ai/import#"</span> + urlencode({<a href="/docs/ja/remote">リモート magpie</a><a href="/docs/ja/docker">Docker</a><a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a><a href="https://github.com/yetone/magpie">GitHub</a><a href="https://discord.gg/vGSnD3ZKQF">Discord</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>diff --git a/site/public/docs/ja/intent.html b/site/public/docs/ja/intent.htmlindex de4fa710e..1295d6aa8 100644--- a/site/public/docs/ja/intent.html+++ b/site/public/docs/ja/intent.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/ja/remote">リモート magpie</a><a class="toc-only" href="/docs/ja/docker">Docker</a><a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>@@ -326,6 +327,7 @@ The number of its kind (0 for none):</pre><a href="/docs/ja/remote">リモート magpie</a><a href="/docs/ja/docker">Docker</a><a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/ja/masking.html b/site/public/docs/ja/masking.htmlnew file mode 100644index 000000000..b1a3df8e9--- /dev/null+++ b/site/public/docs/ja/masking.html@@ -0,0 +1,201 @@+<!doctype html>+<html lang="ja">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1">+<title>プライバシーマスキング · magpie ドキュメント</title>+<meta name="description" content="magpie のローカルなプライバシーマスキングの使い方:リクエストがコンピュータを出る前に何をマスクするか、応答でどう戻るか、効いているかの確かめ方、そして制限。">+<meta name="color-scheme" content="light dark">+<meta name="theme-color" content="#fafafa">+<script>+(() => {+ let mode = "system";+ try { mode = localStorage.getItem("theme") || "system"; } catch {}+ const q = matchMedia("(prefers-color-scheme: dark)");+ const apply = () => {+ const t = mode === "system" ? (q.matches ? "dark" : "light") : mode;+ document.documentElement.dataset.theme = t;+ document.querySelector('meta[name="theme-color"]').content = t === "dark" ? "#0b0b0c" : "#fafafa";+ document.querySelectorAll("button.theme").forEach((b) => { b.dataset.mode = mode; b.title = "Theme: " + mode; });+ };+ q.addEventListener("change", () => mode === "system" && apply());+ window.setTheme = (m) => { mode = m; try { m === "system" ? localStorage.removeItem("theme") : localStorage.setItem("theme", m); } catch {} apply(); };+ window.themeMode = () => mode;+ apply();+})();+</script>+<script>try{if(/Linux/.test(navigator.userAgent)&&!/Android/.test(navigator.userAgent)||localStorage.getItem("omarchy")||/[?&]omarchy=/.test(location.search))document.write('<script src="/omarchy.js"><\/script>')}catch(e){}</script>+<link rel="icon" href="/favicon.png" type="image/png">+<link rel="apple-touch-icon" href="/img/icon-256.png">+<link rel="alternate" hreflang="en" href="https://usemagpie.ai/docs/masking">+<link rel="alternate" hreflang="zh" href="https://usemagpie.ai/docs/zh/masking">+<link rel="alternate" hreflang="ja" href="https://usemagpie.ai/docs/ja/masking">+<link rel="stylesheet" href="/docs.css">+<meta property="og:title" content="プライバシーマスキング">+<meta property="og:description" content="キー、パスワード、個人情報をコンピュータに留める:送る前にマスクし、応答で元に戻します。">+<meta property="og:image" content="https://usemagpie.ai/img/og.png">+<meta property="og:url" content="https://usemagpie.ai/docs/ja/masking">+<meta name="twitter:card" content="summary_large_image">+</head>+<body>++<nav><div class="wrap">+ <a class="brand" href="/ja/"><img class="bird" src="/img/magpie-small.svg" alt="">magpie <small>ドキュメント</small></a>+ <div class="links">+ <a href="/ja/">ホーム</a>+ <a href="/docs/ja/start">はじめに</a>+ <a href="/docs/ja/intent">インテントルーティング</a>+ <a href="/docs/ja/plugins">プラグイン</a>+ <a class="toc-only" href="/docs/ja/remote">リモート magpie</a>+ <a class="toc-only" href="/docs/ja/docker">Docker</a>+ <a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a>+ <a href="/docs/ja/import">magpie に追加</a>+ <a href="/docs/integrate">アプリ連携</a>+ <a href="https://github.com/yetone/magpie-releases/releases">リリース</a>+ </div>+ <div class="langs">+ <button class="icon-btn lang" type="button" aria-label="言語" title="言語" aria-haspopup="true" aria-expanded="false" aria-controls="langs"><svg viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.4" aria-hidden="true"><circle cx="8" cy="8" r="6.25"/><path d="M1.75 8h12.5M8 1.75c1.7 1.75 2.55 3.83 2.55 6.25S9.7 12.5 8 14.25M8 1.75C6.3 3.5 5.45 5.58 5.45 8S6.3 12.5 8 14.25"/></svg></button>+ <div class="lang-menu" id="langs" hidden>+ <a href="/docs/masking" hreflang="en" lang="en">English</a>+ <a href="/docs/zh/masking" hreflang="zh" lang="zh">中文</a>+ <a href="/docs/ja/masking" hreflang="ja" lang="ja">日本語</a>+ </div>+ </div>+ <a class="icon-btn" href="https://discord.gg/vGSnD3ZKQF" aria-label="Discord の magpie" title="Discord に参加"><svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M20.317 4.3698a19.7913 19.7913 0 00-4.8851-1.5152.0741.0741 0 00-.0785.0371c-.211.3753-.4447.8648-.6083 1.2495-1.8447-.2762-3.68-.2762-5.4868 0-.1636-.3933-.4058-.8742-.6177-1.2495a.077.077 0 00-.0785-.037 19.7363 19.7363 0 00-4.8852 1.515.0699.0699 0 00-.0321.0277C.5334 9.0458-.319 13.5799.0992 18.0578a.0824.0824 0 00.0312.0561c2.0528 1.5076 4.0413 2.4228 5.9929 3.0294a.0777.0777 0 00.0842-.0276c.4616-.6304.8731-1.2952 1.226-1.9942a.076.076 0 00-.0416-.1057c-.6528-.2476-1.2743-.5495-1.8722-.8923a.077.077 0 01-.0076-.1277c.1258-.0943.2517-.1923.3718-.2914a.0743.0743 0 01.0776-.0105c3.9278 1.7933 8.18 1.7933 12.0614 0a.0739.0739 0 01.0785.0095c.1202.099.246.1981.3728.2924a.077.077 0 01-.0066.1276 12.2986 12.2986 0 01-1.873.8914.0766.0766 0 00-.0407.1067c.3604.698.7719 1.3628 1.225 1.9932a.076.076 0 00.0842.0286c1.961-.6067 3.9495-1.5219 6.0023-3.0294a.077.077 0 00.0313-.0552c.5004-5.177-.8382-9.6739-3.5485-13.6604a.061.061 0 00-.0312-.0286zM8.02 15.3312c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9555-2.4189 2.157-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.9555 2.4189-2.1569 2.4189zm7.9748 0c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9554-2.4189 2.1569-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.946 2.4189-2.1568 2.4189Z"/></svg></a>+ <a class="icon-btn" href="https://github.com/yetone/magpie" aria-label="GitHub の magpie" title="GitHub のソースコード"><svg viewBox="0 0 16 16" fill="currentColor" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8Z"/></svg></a>+ <button class="icon-btn theme" type="button" aria-label="Theme" title="Theme: system"><svg class="i-system" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5"><rect x="1.75" y="2.75" width="12.5" height="8.5" rx="1.5"/><path d="M5.5 14h5M8 11.25V14"/></svg><svg class="i-light" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"><circle cx="8" cy="8" r="3"/><path d="M8 1v1.5M8 13.5V15M1 8h1.5M13.5 8H15M3 3l1 1M12 12l1 1M3 13l1-1M12 4l1-1"/></svg><svg class="i-dark" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linejoin="round"><path d="M13.5 9.5A5.5 5.5 0 0 1 6.5 2.5a5.5 5.5 0 1 0 7 7Z"/></svg></button>+ <a class="btn small" href="/#get">ダウンロード</a>+</div></nav>++<main class="wrap doc">+ <aside class="toc">+ <p>プライバシーマスキング</p>+ <a href="#overview">概要</a>+ <a href="#on">オンにする</a>+ <a href="#what">マスクされるもの</a>+ <a href="#example">例</a>+ <a href="#check">効いているか確かめる</a>+ <a href="#found">値が見つかったとき</a>+ <a href="#limits">対象外のものと制限</a>+ </aside>++ <article>+ <p class="eyebrow" id="overview">ドキュメント · プライバシーマスキング</p>+ <h1>プライバシーマスキング</h1>+ <p class="lede">magpie は、エージェントが送る内容をこのコンピュータから出る前にマスクできます。API キー、パスワード、トークン、そして選べばメールアドレス、電話番号、自分で決めた語が、<code>{{API_KEY_es6eu6jk}}</code> のようなプレースホルダーとしてベンダーに送られます。応答の中のプレースホルダーは元の値に戻るので、エージェントとファイルには本物の値が残り、ベンダーには見えません。処理はこのコンピュータの magpie のゲートウェイで行われ、<b>既定ではオフ</b>です。</p>++ <div class="callout"><b>magpie を通る内容だけが対象です。</b><a href="/docs/ja/start">magpie に接続した</a>エージェントはゲートウェイ経由でリクエストを送り、どのプロバイダやアカウントが答えてもマスクされます。magpie を通さずベンダーに直接送るエージェントは対象外です。</div>++ <h2 id="on"><a class="anchor" href="#on">オンにする</a></h2>+ <ol class="steps">+ <li><b>ページを開く</b><span class="ui">設定</span> → <span class="ui">プライバシー</span> を開きます。</li>+ <li><b>シークレットをマスク</b><span class="ui">マスクするもの</span> の <span class="ui">シークレットをマスク</span> を <span class="ui">オン</span> にします。API キー、秘密鍵、トークン、パスワードが対象です。</li>+ <li><b>必要なら個人情報も</b><span class="ui">個人情報をマスク</span> を <span class="ui">オン</span> にすると、メールアドレス、電話番号、ID 番号、銀行カード番号もマスクされます。オンにすると、その下に個人情報の種類ごとのスイッチが並びます。</li>+ <li><b>自分の語</b><span class="ui">マスクする語</span> に、ベンダーに見せたくない名前、コードネーム、ホスト名をカンマ区切りで入れます。<span class="ui">マスクする語の大文字・小文字を区別しない</span> をオンにすると、<em>Nightjar</em> で <em>NIGHTJAR</em> もマスクされます。magpie が知らないシークレット(自分のゲートウェイのキーなど)は <span class="ui">マスクルール</span> に、先頭の文字列か正規表現で追加します。</li>+ <li><b>試す</b><span class="ui">試す</span> にテキストを貼ると、ベンダーが実際に受け取る内容が表示されます。貼った内容は保存されません。</li>+ </ol>+ <p>変更は次のリクエストから効き、再起動もエージェント側の変更もいりません。実際にマスクするのは組み込みプラグイン <span class="ui">プライバシーマスキング</span>(<code>redact</code>、<span class="ui">設定</span> → <span class="ui">プラグイン</span>)で、何かのマスクが求められている間は常にオンです。</p>+ <p>専用の CLI コマンドはありません。ウィンドウがないとき(<code>magpie serve</code>、<a href="/docs/ja/docker">Docker</a>)は <code>magpie web</code> で同じページを開くか、<code>~/.config/magpie/settings.json</code>(Docker では <code>/config/magpie/settings.json</code>)に書きます。ファイルはリクエストごとに読み直されます。</p>+ <div class="code">+ <span class="lang">settings.json</span>+ <button class="copy" data-copy="ex-settings">コピー</button>+ <pre id="ex-settings">{+ <span class="s">"redact"</span>: true,+ <span class="s">"redactPersonal"</span>: true,+ <span class="s">"redactWords"</span>: [<span class="s">"Nightjar"</span>, <span class="s">"db.acme-corp.cn"</span>]+}</pre>+ </div>++ <h2 id="what"><a class="anchor" href="#what">マスクされるもの</a></h2>+ <div class="table-wrap"><table>+ <tr><th>スイッチ</th><th>見つけるもの</th></tr>+ <tr><td><span class="ui">シークレットをマスク</span></td><td>秘密鍵のブロック(<code>-----BEGIN … PRIVATE KEY-----</code>)。形で見分ける API キー:<code>sk-…</code>(OpenAI、Anthropic、OpenRouter)、<code>ghp_</code>/<code>github_pat_</code>、<code>glpat-</code>、<code>AIza…</code>、<code>xox…-</code>、<code>sk_live_</code>、<code>AKIA</code>/<code>ASIA</code>、<code>hf_</code>、<code>gsk_</code>、<code>xai-</code>、<code>npm_</code>、<code>pypi-</code>、<code>dop_v1_</code>、<code>SG.</code>、それに <code>oc_sk_…</code> のような中継サービスのキー。JWT。<code>user:password@host</code> のパスワード。<code>.env</code> や設定ファイルでシークレットの名前が付いたフィールドの値:<code>DB_PASSWORD=…</code>、<code>api_key: …</code>、<code>client_secret</code>、<code>token</code>、<code>credential</code>。それと自分の <span class="ui">マスクルール</span>。</td></tr>+ <tr><td><span class="ui">個人情報をマスク</span></td><td>メールアドレス、中国本土の携帯番号、チェックサムの合う中国の身分証番号と銀行カード番号。既定でオンのもの:米国の社会保障番号、パスポート番号(<em>passport</em>、护照、パスポートの後)、IBAN、誕生日(<em>birthday</em>、<em>DOB</em>、生日の近く)、MAC アドレス、シリアル番号(<em>S/N</em> の後)。エージェントがほぼ毎回送るので、自分でオンにするまでオフのもの:ホームフォルダのユーザー名、ユーザー名とコンピュータ名(<code>user@host</code>)、パブリック IP アドレス、クラウドストレージのバケット。</td></tr>+ <tr><td><span class="ui">マスクする語</span></td><td>入れた語そのままを <code>{{TERM_…}}</code> に。</td></tr>+ <tr><td><span class="ui">ローカルモデルで検出</span></td><td><span class="ui">検出方法</span> の中にあります。このコンピュータで動くモデル(OpenAI の Privacy Filter、1.6 GB のダウンロード)が、ルールでは見つからない自由文中の名前や住所を見つけます。<span class="ui">シークレットをマスク</span> か <span class="ui">個人情報をマスク</span> がオンのときに使え、見つけたものは同じスイッチに従います。</td></tr>+ </table></div>+ <p>プレースホルダーは「種類 + 鍵付きハッシュの 8 文字」です。同じ値はいつも同じプレースホルダーになるので、会話は毎ターン同じに読め、ベンダーのプロンプトキャッシュも有効なままです。値はメモリにだけ置かれます。</p>++ <h2 id="example"><a class="anchor" href="#example">例</a></h2>+ <p><span class="ui">シークレットをマスク</span> と <span class="ui">個人情報をマスク</span> をオンにし、<span class="ui">マスクする語</span> に <em>Nightjar</em> を入れた状態で、エージェントがこう送ったとします。</p>+ <div class="code">+ <span class="lang">エージェントが送る内容</span>+ <pre>Deploy Nightjar with OPENAI_API_KEY=sk-proj-8fK2mQx7Lp4Rt9Vw3Yz6Ab1Cd, then mail [email protected] or call 13800138000.</pre>+ </div>+ <div class="code">+ <span class="lang">ベンダーが受け取る内容</span>+ <pre>Deploy {{TERM_5hmsrhdc}} with OPENAI_API_KEY={{API_KEY_srhjgvja}}, then mail {{EMAIL_eh5um6mb}} or call {{PHONE_uf7iy2qq}}.</pre>+ </div>+ <p>モデルが <em>「.env の OPENAI_API_KEY を {{API_KEY_srhjgvja}} にしました」</em> と答えると、エージェントにはストリームのテキストでもツール呼び出しの引数でも本物のキーが届き、書き込むファイルにも本物のキーが入ります。モデルが少し書き換えたプレースホルダー(波括弧の中の空白、大文字・小文字の違い)も元に戻ります。</p>++ <h2 id="check"><a class="anchor" href="#check">効いているか確かめる</a></h2>+ <ul>+ <li><b>事前に:</b><span class="ui">設定</span> → <span class="ui">プライバシー</span> の <span class="ui">試す</span> が、ベンダーが受け取るテキストと各値の種類を表示します。</li>+ <li><b>リクエストごとに:</b><span class="ui">ゲートウェイ</span> ページの最近の呼び出しと <span class="ui">ルーティング</span> のログで、マスクされたリクエストに盾のバッジと件数が付きます。ポインタを合わせると種類が、クリックするとそのリクエストの記録が開きます。</li>+ <li><b>期間で:</b><span class="ui">観測</span> → <span class="ui">マスク</span>(プライバシーページの <span class="ui">マスクの記録</span> からも開けます)が、7 日間または 30 日間にマスクした値を種類、エージェント、プロバイダ別に示し、各リクエストがベンダーにどう見えたかをプレースホルダーに印を付けて表示します。</li>+ </ul>+ <p>記録は <code>~/.config/magpie/masking</code> に 30 日間残ります。エージェント、プロバイダ、モデル、各プレースホルダーの種類、長さ、先頭の数文字だけで、値そのものは残りません。</p>++ <h2 id="found"><a class="anchor" href="#found">値が見つかったとき</a></h2>+ <p><span class="ui">値が見つかったとき</span> で、種類ごとに選べます。</p>+ <ul>+ <li><span class="ui">マスク</span>(既定):プレースホルダーにして送ります。</li>+ <li><span class="ui">警告</span>:そのまま送り、バッジが琥珀色で数えます。</li>+ <li><span class="ui">ブロック</span>:リクエストを止め、400 を返します:<em>“magpie held this request back: Settings › Privacy blocks API_KEY, and it has one (sk-…, 33 characters). Nothing was sent.”</em> メッセージに値は含まれません。</li>+ </ul>+ <p>タスクでそのまま使う必要のある値(チームのアドレス、テスト用のキー)は <span class="ui">マスクしない</span> に入れます。値全体が一致すれば、そのまま送られます。</p>++ <h2 id="limits"><a class="anchor" href="#limits">対象外のものと制限</a></h2>+ <ul>+ <li><b>思考はベンダーが書いたまま。</b>署名付きの thinking ブロック、Gemini の thoughts、Responses の暗号化された推論はベンダーが署名したものなので、署名が合うよう変えずに送り返します。中で置き換えるのは、リクエストの他の場所ですでにマスクした値だけです。</li>+ <li><b>ID とツール定義はそのまま:</b>モデル ID、メッセージや呼び出しの ID、UUID、ツール名、MCP サーバー名、ツールのスキーマ(説明文はマスクされます)。ベンダーやツールが検証できるようにするためです。</li>+ <li><b>画像とファイルのデータはそのまま送られます。</b>スクリーンショット内の文字はマスクされません。</li>+ <li><b>動かなければ送りません。</b>マスクがオンなのに動かないとき(<span class="ui">プライバシーマスキング</span> プラグインを手で止めた、ローカルモデルがオンなのに応答しない)、リクエストは何も送らなかったことを示す 503 になります。マスクなしで送ることはありません。</li>+ <li><b>ローカルモデルは外せます。</b>すべてのアドレスがこのコンピュータかローカルネットワーク上にあるプロバイダ(Ollama、LM Studio)は、<span class="ui">リクエストをマスクしない</span> でそのまま送れます。CLI では <code>magpie provider set ollama unmasked=yes</code>。ログにはマスク後の内容が残ります。</li>+ <li><b>モデルにはプレースホルダーしか見えません。</b>マスクされた値を読んだり推論したりはできず、受け渡すだけです。モデルが読む必要のある値は <span class="ui">マスクしない</span> へ。</li>+ <li><b>ルールは形で見つけます。</b>他の国の形式の電話番号や自由文中の名前には、<span class="ui">ローカルモデルで検出</span>、または自分の <span class="ui">マスクする語</span> と <span class="ui">マスクルール</span> が必要です。まず自分のテキストを <span class="ui">試す</span> で確かめてください。</li>+ </ul>+ <p>magpie が自分で送るものは <a href="/docs/ja/privacy">プライバシー</a> を参照してください。コードは <a href="https://github.com/yetone/magpie/tree/main/internal/redact">internal/redact</a> と <a href="https://github.com/yetone/magpie/blob/main/internal/masking/masking.go">internal/masking</a> です。</p>+ </article>+</main>++<footer><div class="wrap">+ <span>© 2026 magpie · MIT</span>+ <div class="links">+ <a href="/ja/">ホーム</a>+ <a href="/docs/ja/start">はじめに</a>+ <a href="/docs/ja/intent">インテントルーティング</a>+ <a href="/docs/ja/plugins">プラグイン</a>+ <a href="/docs/ja/remote">リモート magpie</a>+ <a href="/docs/ja/docker">Docker</a>+ <a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a>+ <a href="/docs/ja/import">magpie に追加</a>+ <a href="/docs/integrate">アプリ連携</a>+ <a href="https://github.com/yetone/magpie">GitHub</a>+ <a href="https://discord.gg/vGSnD3ZKQF">Discord</a>+ <a href="https://github.com/yetone/magpie-releases/releases">リリース</a>+ </div>+</div></footer>++<script>+(() => {+ const next = { system: "light", light: "dark", dark: "system" };+ document.querySelectorAll("button.theme").forEach((b) => {+ b.dataset.mode = themeMode();+ b.title = "Theme: " + themeMode();+ b.addEventListener("click", () => setTheme(next[themeMode()]));+ });++ document.querySelectorAll(".copy").forEach((b) => b.addEventListener("click", async () => {+ try {+ await navigator.clipboard.writeText(document.getElementById(b.dataset.copy).textContent);+ b.textContent = "コピーしました"; setTimeout(() => (b.textContent = "コピー"), 1400);+ } catch {}+ }));+})();+</script>+<script src="/docs.js"></script>+</body>+</html>diff --git a/site/public/docs/ja/plugins.html b/site/public/docs/ja/plugins.htmlindex f706dc5be..0d853a1ec 100644--- a/site/public/docs/ja/plugins.html+++ b/site/public/docs/ja/plugins.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/ja/remote">リモート magpie</a><a class="toc-only" href="/docs/ja/docker">Docker</a><a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>@@ -960,6 +961,7 @@ document.getElementById(<span class="s">"calls"</span>).textContent = `${s.calls<a href="/docs/ja/remote">リモート magpie</a><a href="/docs/ja/docker">Docker</a><a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/ja/privacy.html b/site/public/docs/ja/privacy.htmlindex 2e35214b9..c806caf45 100644--- a/site/public/docs/ja/privacy.html+++ b/site/public/docs/ja/privacy.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/ja/remote">リモート magpie</a><a class="toc-only" href="/docs/ja/docker">Docker</a><a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>@@ -197,6 +198,7 @@<li>値はメモリにだけ置かれ、ディスク上の記録は種類、長さ、先頭の数文字だけ。マスクがオンなのに動かないときは、リクエストは 503 になり、何も送られません。</li><li>モデルに見えるのはプレースホルダーで、値そのものではありません。そのまま使う必要のある値(チームのアドレス、テスト用のキー)は <span class="ui">マスクしない</span> に入れてください。</li></ul>+ <p>オンにする方法、各スイッチがマスクするもの、例、効いているかの確かめ方は <a href="/docs/ja/masking">プライバシーマスキング</a> へ。</p><h2 id="why"><a class="anchor" href="#why">カウントが既定でオンの理由</a></h2><p>magpie は何十ものエージェントとプロバイダーに対応し、少人数で保守しています。毎日のカウントは、実際に使われているものを知り、それを優先して動くように保つための手段です。リリース版で既定オンなのは、自分でオンにする人の数だけでは少なすぎて、それがわからないからです。その代わり、送るものは小さく保っています。ランダムな ID、組み込みの ID、数だけです。スイッチ 1 つか <code>DO_NOT_TRACK=1</code> でオフにでき、ソースからのビルドは送らず、送るものはすべてこのページに挙げています。</p>@@ -213,6 +215,7 @@<a href="/docs/ja/remote">リモート magpie</a><a href="/docs/ja/docker">Docker</a><a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/ja/remote.html b/site/public/docs/ja/remote.htmlindex 94f579512..b0ae5c9dd 100644--- a/site/public/docs/ja/remote.html+++ b/site/public/docs/ja/remote.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/ja/remote">リモート magpie</a><a class="toc-only" href="/docs/ja/docker">Docker</a><a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>@@ -155,6 +156,7 @@ magpie provider refresh office <span class="c"># 一覧を再取得</span></pr<a href="/docs/ja/remote">リモート magpie</a><a href="/docs/ja/docker">Docker</a><a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/ja/start.html b/site/public/docs/ja/start.htmlindex 0abc15e0d..6539c4c9a 100644--- a/site/public/docs/ja/start.html+++ b/site/public/docs/ja/start.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/ja/remote">リモート magpie</a><a class="toc-only" href="/docs/ja/docker">Docker</a><a class="toc-only" href="/docs/ja/privacy">プライバシー</a>+ <a class="toc-only" href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie-releases/releases">リリース</a>@@ -325,6 +326,7 @@ IP-CIDR6,::1/128,DIRECT,no-resolve</pre><a href="/docs/ja/remote">リモート magpie</a><a href="/docs/ja/docker">Docker</a><a href="/docs/ja/privacy">プライバシー</a>+ <a href="/docs/ja/masking">プライバシーマスキング</a><a href="/docs/ja/import">magpie に追加</a><a href="/docs/integrate">アプリ連携</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/masking.html b/site/public/docs/masking.htmlnew file mode 100644index 000000000..474fdeec5--- /dev/null+++ b/site/public/docs/masking.html@@ -0,0 +1,201 @@+<!doctype html>+<html lang="en">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1">+<title>Privacy masking · magpie docs</title>+<meta name="description" content="How to turn on magpie's local privacy masking: what it masks before a request leaves your computer, how values come back in replies, how to check it worked, and its limits.">+<meta name="color-scheme" content="light dark">+<meta name="theme-color" content="#fafafa">+<script>+(() => {+ let mode = "system";+ try { mode = localStorage.getItem("theme") || "system"; } catch {}+ const q = matchMedia("(prefers-color-scheme: dark)");+ const apply = () => {+ const t = mode === "system" ? (q.matches ? "dark" : "light") : mode;+ document.documentElement.dataset.theme = t;+ document.querySelector('meta[name="theme-color"]').content = t === "dark" ? "#0b0b0c" : "#fafafa";+ document.querySelectorAll("button.theme").forEach((b) => { b.dataset.mode = mode; b.title = "Theme: " + mode; });+ };+ q.addEventListener("change", () => mode === "system" && apply());+ window.setTheme = (m) => { mode = m; try { m === "system" ? localStorage.removeItem("theme") : localStorage.setItem("theme", m); } catch {} apply(); };+ window.themeMode = () => mode;+ apply();+})();+</script>+<script>try{if(/Linux/.test(navigator.userAgent)&&!/Android/.test(navigator.userAgent)||localStorage.getItem("omarchy")||/[?&]omarchy=/.test(location.search))document.write('<script src="/omarchy.js"><\/script>')}catch(e){}</script>+<link rel="icon" href="/favicon.png" type="image/png">+<link rel="apple-touch-icon" href="/img/icon-256.png">+<link rel="alternate" hreflang="en" href="https://usemagpie.ai/docs/masking">+<link rel="alternate" hreflang="zh" href="https://usemagpie.ai/docs/zh/masking">+<link rel="alternate" hreflang="ja" href="https://usemagpie.ai/docs/ja/masking">+<link rel="stylesheet" href="/docs.css">+<meta property="og:title" content="Privacy masking">+<meta property="og:description" content="Keep keys, passwords and personal data on your computer: masked before a request leaves it, restored in the reply.">+<meta property="og:image" content="https://usemagpie.ai/img/og.png">+<meta property="og:url" content="https://usemagpie.ai/docs/masking">+<meta name="twitter:card" content="summary_large_image">+</head>+<body>++<nav><div class="wrap">+ <a class="brand" href="/"><img class="bird" src="/img/magpie-small.svg" alt="">magpie <small>Docs</small></a>+ <div class="links">+ <a href="/">Home</a>+ <a href="/docs/start">Get started</a>+ <a href="/docs/intent">Intent routing</a>+ <a href="/docs/plugins">Plugins</a>+ <a class="toc-only" href="/docs/remote">Remote magpie</a>+ <a class="toc-only" href="/docs/docker">Docker</a>+ <a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a>+ <a href="/docs/import">Add to magpie</a>+ <a href="/docs/integrate">Integrate</a>+ <a href="https://github.com/yetone/magpie-releases/releases">Releases</a>+ </div>+ <div class="langs">+ <button class="icon-btn lang" type="button" aria-label="Language" title="Language" aria-haspopup="true" aria-expanded="false" aria-controls="langs"><svg viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.4" aria-hidden="true"><circle cx="8" cy="8" r="6.25"/><path d="M1.75 8h12.5M8 1.75c1.7 1.75 2.55 3.83 2.55 6.25S9.7 12.5 8 14.25M8 1.75C6.3 3.5 5.45 5.58 5.45 8S6.3 12.5 8 14.25"/></svg></button>+ <div class="lang-menu" id="langs" hidden>+ <a href="/docs/masking" hreflang="en" lang="en">English</a>+ <a href="/docs/zh/masking" hreflang="zh" lang="zh">中文</a>+ <a href="/docs/ja/masking" hreflang="ja" lang="ja">日本語</a>+ </div>+ </div>+ <a class="icon-btn" href="https://discord.gg/vGSnD3ZKQF" aria-label="magpie on Discord" title="Join us on Discord"><svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M20.317 4.3698a19.7913 19.7913 0 00-4.8851-1.5152.0741.0741 0 00-.0785.0371c-.211.3753-.4447.8648-.6083 1.2495-1.8447-.2762-3.68-.2762-5.4868 0-.1636-.3933-.4058-.8742-.6177-1.2495a.077.077 0 00-.0785-.037 19.7363 19.7363 0 00-4.8852 1.515.0699.0699 0 00-.0321.0277C.5334 9.0458-.319 13.5799.0992 18.0578a.0824.0824 0 00.0312.0561c2.0528 1.5076 4.0413 2.4228 5.9929 3.0294a.0777.0777 0 00.0842-.0276c.4616-.6304.8731-1.2952 1.226-1.9942a.076.076 0 00-.0416-.1057c-.6528-.2476-1.2743-.5495-1.8722-.8923a.077.077 0 01-.0076-.1277c.1258-.0943.2517-.1923.3718-.2914a.0743.0743 0 01.0776-.0105c3.9278 1.7933 8.18 1.7933 12.0614 0a.0739.0739 0 01.0785.0095c.1202.099.246.1981.3728.2924a.077.077 0 01-.0066.1276 12.2986 12.2986 0 01-1.873.8914.0766.0766 0 00-.0407.1067c.3604.698.7719 1.3628 1.225 1.9932a.076.076 0 00.0842.0286c1.961-.6067 3.9495-1.5219 6.0023-3.0294a.077.077 0 00.0313-.0552c.5004-5.177-.8382-9.6739-3.5485-13.6604a.061.061 0 00-.0312-.0286zM8.02 15.3312c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9555-2.4189 2.157-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.9555 2.4189-2.1569 2.4189zm7.9748 0c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9554-2.4189 2.1569-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.946 2.4189-2.1568 2.4189Z"/></svg></a>+ <a class="icon-btn" href="https://github.com/yetone/magpie" aria-label="magpie on GitHub" title="Source on GitHub"><svg viewBox="0 0 16 16" fill="currentColor" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8Z"/></svg></a>+ <button class="icon-btn theme" type="button" aria-label="Theme" title="Theme: system"><svg class="i-system" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5"><rect x="1.75" y="2.75" width="12.5" height="8.5" rx="1.5"/><path d="M5.5 14h5M8 11.25V14"/></svg><svg class="i-light" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"><circle cx="8" cy="8" r="3"/><path d="M8 1v1.5M8 13.5V15M1 8h1.5M13.5 8H15M3 3l1 1M12 12l1 1M3 13l1-1M12 4l1-1"/></svg><svg class="i-dark" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linejoin="round"><path d="M13.5 9.5A5.5 5.5 0 0 1 6.5 2.5a5.5 5.5 0 1 0 7 7Z"/></svg></button>+ <a class="btn small" href="/#get">Download</a>+</div></nav>++<main class="wrap doc">+ <aside class="toc">+ <p>Privacy masking</p>+ <a href="#overview">Overview</a>+ <a href="#on">Turn it on</a>+ <a href="#what">What is masked</a>+ <a href="#example">An example</a>+ <a href="#check">Check that it works</a>+ <a href="#found">When a value is found</a>+ <a href="#limits">What it leaves alone, and limits</a>+ </aside>++ <article>+ <p class="eyebrow" id="overview">Docs · Privacy masking</p>+ <h1>Privacy masking</h1>+ <p class="lede">magpie can mask what your agents send before it leaves this computer. API keys, passwords and tokens, and when you ask, emails, phone numbers and words of your own, go to the vendor as placeholders such as <code>{{API_KEY_es6eu6jk}}</code>. In the reply each placeholder turns back into its value, so your agent and your files keep the real thing and the vendor never sees it. It runs on this computer, in magpie’s gateway, and is <b>off by default</b>.</p>++ <div class="callout"><b>It covers what goes through magpie.</b> An agent <a href="/docs/start">connected to magpie</a> sends its requests through the gateway, and they are masked whichever provider or account answers. An agent that calls a vendor directly, not through magpie, is not covered.</div>++ <h2 id="on"><a class="anchor" href="#on">Turn it on</a></h2>+ <ol class="steps">+ <li><b>Open the page</b>Go to <span class="ui">Settings</span> → <span class="ui">Privacy</span>.</li>+ <li><b>Mask secrets</b>Under <span class="ui">What to mask</span>, set <span class="ui">Mask secrets</span> to <span class="ui">On</span>: API keys, private keys, tokens and passwords.</li>+ <li><b>Personal data, if you want it</b>Set <span class="ui">Mask personal data</span> to <span class="ui">On</span> for emails, phone numbers, ID and bank card numbers. Each further kind of personal data then gets its own switch below it.</li>+ <li><b>Your own words</b>In <span class="ui">Masked words</span>, list names, codenames or hosts to keep from vendors, separated by commas. <span class="ui">Masked words in any case</span> makes <em>Nightjar</em> mask <em>NIGHTJAR</em> too. A secret magpie doesn’t know, such as your gateway’s own keys, goes under <span class="ui">Masking rules</span>: what it starts with, or a regular expression.</li>+ <li><b>Try it</b>Paste a text into <span class="ui">Try it</span> to see exactly what the vendor would get. What you paste there isn’t kept.</li>+ </ol>+ <p>It applies from the next request, with no restart and nothing to change in your agent. The work is done by the built-in plugin <span class="ui">Privacy masking</span> (<code>redact</code>, in <span class="ui">Settings</span> → <span class="ui">Plugins</span>), which is on whenever any masking is asked for.</p>+ <p>There is no CLI command for it. Without the window (<code>magpie serve</code>, <a href="/docs/docker">Docker</a>), open the same page with <code>magpie web</code>, or set it in <code>~/.config/magpie/settings.json</code> (<code>/config/magpie/settings.json</code> in Docker). The masker reads the file on every request:</p>+ <div class="code">+ <span class="lang">settings.json</span>+ <button class="copy" data-copy="ex-settings">Copy</button>+ <pre id="ex-settings">{+ <span class="s">"redact"</span>: true,+ <span class="s">"redactPersonal"</span>: true,+ <span class="s">"redactWords"</span>: [<span class="s">"Nightjar"</span>, <span class="s">"db.acme-corp.cn"</span>]+}</pre>+ </div>++ <h2 id="what"><a class="anchor" href="#what">What is masked</a></h2>+ <div class="table-wrap"><table>+ <tr><th>Switch</th><th>What it finds</th></tr>+ <tr><td><span class="ui">Mask secrets</span></td><td>Private key blocks (<code>-----BEGIN … PRIVATE KEY-----</code>). API keys by their shape: <code>sk-…</code> (OpenAI, Anthropic, OpenRouter), <code>ghp_</code>/<code>github_pat_</code>, <code>glpat-</code>, <code>AIza…</code>, <code>xox…-</code>, <code>sk_live_</code>, <code>AKIA</code>/<code>ASIA</code>, <code>hf_</code>, <code>gsk_</code>, <code>xai-</code>, <code>npm_</code>, <code>pypi-</code>, <code>dop_v1_</code>, <code>SG.</code>, and relay keys like <code>oc_sk_…</code>. JWTs. The password in <code>user:password@host</code>. The value of a field named for a secret, as <code>.env</code> files and configs have them: <code>DB_PASSWORD=…</code>, <code>api_key: …</code>, <code>client_secret</code>, <code>token</code>, <code>credential</code>. Your own <span class="ui">Masking rules</span>.</td></tr>+ <tr><td><span class="ui">Mask personal data</span></td><td>Emails, mainland China mobile numbers, Chinese ID numbers and bank card numbers whose checksum adds up. Also on by default: US Social Security numbers, passport numbers (after <em>passport</em>, 护照 or パスポート), IBANs, birthdays (next to <em>birthday</em>, <em>DOB</em> or 生日), MAC addresses and serial numbers (after <em>S/N</em>). Off until you turn them on, since agents send them in nearly every request: the user name in home folders, user and computer names (<code>user@host</code>), public IP addresses and cloud storage buckets.</td></tr>+ <tr><td><span class="ui">Masked words</span></td><td>Each word you listed, exactly, as <code>{{TERM_…}}</code>.</td></tr>+ <tr><td><span class="ui">Find with a local model</span></td><td>Under <span class="ui">How it’s found</span>. A model on this computer (OpenAI’s Privacy Filter, a 1.6 GB download) finds what no rule can: a name or an address in free text. It needs <span class="ui">Mask secrets</span> or <span class="ui">Mask personal data</span> on, and finds under the same switches.</td></tr>+ </table></div>+ <p>A placeholder is the kind plus eight characters of a keyed hash. The same value gets the same placeholder every time, so the conversation reads the same turn after turn and the vendor’s prompt cache stays valid. The values are held in memory only.</p>++ <h2 id="example"><a class="anchor" href="#example">An example</a></h2>+ <p>With <span class="ui">Mask secrets</span> and <span class="ui">Mask personal data</span> on and <em>Nightjar</em> in <span class="ui">Masked words</span>, your agent sends:</p>+ <div class="code">+ <span class="lang">Your agent sends</span>+ <pre>Deploy Nightjar with OPENAI_API_KEY=sk-proj-8fK2mQx7Lp4Rt9Vw3Yz6Ab1Cd, then mail [email protected] or call 13800138000.</pre>+ </div>+ <div class="code">+ <span class="lang">The vendor gets</span>+ <pre>Deploy {{TERM_5hmsrhdc}} with OPENAI_API_KEY={{API_KEY_srhjgvja}}, then mail {{EMAIL_eh5um6mb}} or call {{PHONE_uf7iy2qq}}.</pre>+ </div>+ <p>When the model answers <em>“I set OPENAI_API_KEY to {{API_KEY_srhjgvja}} in .env”</em>, your agent reads the real key there, in streamed text and tool-call arguments alike, so the file it writes has the real key. A placeholder the model rewrote a little (spaces inside the braces, another case) is still turned back.</p>++ <h2 id="check"><a class="anchor" href="#check">Check that it works</a></h2>+ <ul>+ <li><b>Before:</b> <span class="ui">Try it</span> on <span class="ui">Settings</span> → <span class="ui">Privacy</span> shows the text as the vendor would get it, with each value’s kind.</li>+ <li><b>Each request:</b> a shield badge with a count appears on the request in the <span class="ui">Gateway</span> page’s recent calls and in the <span class="ui">Routing</span> log. Point at it for the kinds; click it to open the request’s record.</li>+ <li><b>Over time:</b> <span class="ui">Insights</span> → <span class="ui">Masking</span> (also <span class="ui">What was masked</span> on the Privacy page) shows the values masked over 7 or 30 days by kind, agent and provider, and each request’s text as the vendor saw it, placeholders marked.</li>+ </ul>+ <p>The records are kept in <code>~/.config/magpie/masking</code> for 30 days: the agent, provider, model, and each placeholder’s kind, length and first characters, never the value.</p>++ <h2 id="found"><a class="anchor" href="#found">When a value is found</a></h2>+ <p>Under <span class="ui">When a value is found</span>, choose per kind:</p>+ <ul>+ <li><span class="ui">Mask</span> (the default): sent as a placeholder.</li>+ <li><span class="ui">Warn</span>: sent as written, and the badge counts it in amber.</li>+ <li><span class="ui">Block</span>: the request is held back with a 400, <em>“magpie held this request back: Settings › Privacy blocks API_KEY, and it has one (sk-…, 33 characters). Nothing was sent.”</em> The message never has the value.</li>+ </ul>+ <p>A value the task needs as it is, such as a team address or a test key, goes in <span class="ui">Never mask</span>: it is sent as written wherever it is found whole.</p>++ <h2 id="limits"><a class="anchor" href="#limits">What it leaves alone, and limits</a></h2>+ <ul>+ <li><b>Thinking stays as the vendor wrote it.</b> A thinking block with its signature, Gemini’s thoughts and Responses’ encrypted reasoning are sealed by the vendor and go back unchanged, so the signature still matches. Only values already masked elsewhere in the request are swapped in them.</li>+ <li><b>Ids and tool definitions go as written:</b> model ids, message and call ids, UUIDs, tool names, MCP server names, and tool schemas (their descriptions are masked), so a vendor or a tool can still check them.</li>+ <li><b>Images and file data are sent as they are.</b> Text inside a screenshot is not masked.</li>+ <li><b>It fails closed.</b> If masking is on and can’t run (the <span class="ui">Privacy masking</span> plugin turned off by hand, or the local model is on and can’t answer), the request gets a 503 that says nothing was sent. It is never sent unmasked instead.</li>+ <li><b>Local models can skip it.</b> <span class="ui">Send requests unmasked</span> on a provider whose every address is on this computer or your local network (Ollama, LM Studio) sends its requests as written; <code>magpie provider set ollama unmasked=yes</code> does the same. The logs keep the masked body.</li>+ <li><b>The model sees placeholders.</b> It can’t read or reason about a masked value; it can only pass it on. Put a value it must read under <span class="ui">Never mask</span>.</li>+ <li><b>Rules find shapes.</b> A phone number in another country’s format or a name in free text needs <span class="ui">Find with a local model</span>, or your own <span class="ui">Masked words</span> and <span class="ui">Masking rules</span>. Try your own text in <span class="ui">Try it</span> first.</li>+ </ul>+ <p>See also <a href="/docs/privacy">Privacy</a> for everything magpie sends by itself. The code is <a href="https://github.com/yetone/magpie/tree/main/internal/redact">internal/redact</a> and <a href="https://github.com/yetone/magpie/blob/main/internal/masking/masking.go">internal/masking</a>.</p>+ </article>+</main>++<footer><div class="wrap">+ <span>© 2026 magpie · MIT</span>+ <div class="links">+ <a href="/">Home</a>+ <a href="/docs/start">Get started</a>+ <a href="/docs/intent">Intent routing</a>+ <a href="/docs/plugins">Plugins</a>+ <a href="/docs/remote">Remote magpie</a>+ <a href="/docs/docker">Docker</a>+ <a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a>+ <a href="/docs/import">Add to magpie</a>+ <a href="/docs/integrate">Integrate</a>+ <a href="https://github.com/yetone/magpie">GitHub</a>+ <a href="https://discord.gg/vGSnD3ZKQF">Discord</a>+ <a href="https://github.com/yetone/magpie-releases/releases">Releases</a>+ </div>+</div></footer>++<script>+(() => {+ const next = { system: "light", light: "dark", dark: "system" };+ document.querySelectorAll("button.theme").forEach((b) => {+ b.dataset.mode = themeMode();+ b.title = "Theme: " + themeMode();+ b.addEventListener("click", () => setTheme(next[themeMode()]));+ });++ document.querySelectorAll(".copy").forEach((b) => b.addEventListener("click", async () => {+ try {+ await navigator.clipboard.writeText(document.getElementById(b.dataset.copy).textContent);+ b.textContent = "Copied"; setTimeout(() => (b.textContent = "Copy"), 1400);+ } catch {}+ }));+})();+</script>+<script src="/docs.js"></script>+</body>+</html>diff --git a/site/public/docs/plugins.html b/site/public/docs/plugins.htmlindex 4b6a47061..7bcec33bc 100644--- a/site/public/docs/plugins.html+++ b/site/public/docs/plugins.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -960,6 +961,7 @@ document.getElementById(<span class="s">"calls"</span>).textContent = `${s.calls<a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/privacy.html b/site/public/docs/privacy.htmlindex 87623b3aa..4873f9a46 100644--- a/site/public/docs/privacy.html+++ b/site/public/docs/privacy.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -197,6 +198,7 @@<li>Values are held in memory only; the record on disk keeps each value’s kind, length and first characters. If masking is on and can’t run, the request gets a 503 and nothing is sent.</li><li>The model sees the placeholder, not the value. A value a task needs as it is (a team address, a test key) goes under <span class="ui">Never mask</span>.</li></ul>+ <p>How to turn it on, what each switch masks, an example and how to check it: <a href="/docs/masking">Privacy masking</a>.</p><h2 id="why"><a class="anchor" href="#why">Why the count is on</a></h2><p>magpie works with dozens of agents and providers, and is maintained by a small team. The daily count is how we know which of them people actually use, so they are kept working first. It is on in releases because counts from those who turn it on would be too few to tell that. In exchange it is kept small: a random id, built-in ids, numbers; one switch or <code>DO_NOT_TRACK=1</code> turns it off, builds from source never send it, and this page lists everything that goes.</p>@@ -213,6 +215,7 @@<a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/remote.html b/site/public/docs/remote.htmlindex d88d69995..76e2da152 100644--- a/site/public/docs/remote.html+++ b/site/public/docs/remote.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -155,6 +156,7 @@ magpie provider refresh office <span class="c"># fetch its list again</span></<a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/start.html b/site/public/docs/start.htmlindex 5d31995b0..49acbeee5 100644--- a/site/public/docs/start.html+++ b/site/public/docs/start.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/remote">Remote magpie</a><a class="toc-only" href="/docs/docker">Docker</a><a class="toc-only" href="/docs/privacy">Privacy</a>+ <a class="toc-only" href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie-releases/releases">Releases</a>@@ -325,6 +326,7 @@ IP-CIDR6,::1/128,DIRECT,no-resolve</pre><a href="/docs/remote">Remote magpie</a><a href="/docs/docker">Docker</a><a href="/docs/privacy">Privacy</a>+ <a href="/docs/masking">Privacy masking</a><a href="/docs/import">Add to magpie</a><a href="/docs/integrate">Integrate</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/zh/docker.html b/site/public/docs/zh/docker.htmlindex 1adbd5d00..cd76a175a 100644--- a/site/public/docs/zh/docker.html+++ b/site/public/docs/zh/docker.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -219,6 +220,7 @@ docker logs magpie</pre><a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/zh/import.html b/site/public/docs/zh/import.htmlindex 76b45f50e..8ff49f1fe 100644--- a/site/public/docs/zh/import.html+++ b/site/public/docs/zh/import.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -263,6 +264,7 @@ href = <span class="s">"https://usemagpie.ai/import#"</span> + urlencode({<a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="https://github.com/yetone/magpie">GitHub</a><a href="https://discord.gg/vGSnD3ZKQF">Discord</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>diff --git a/site/public/docs/zh/integrate.html b/site/public/docs/zh/integrate.htmlindex 4ea3cae2f..3f38bf66b 100644--- a/site/public/docs/zh/integrate.html+++ b/site/public/docs/zh/integrate.html@@ -48,6 +48,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -154,6 +155,7 @@ curl -s http://127.0.0.1:3425/v1/models -H "Authorization: Bearer magpie-acme"</<a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/zh/intent.html b/site/public/docs/zh/intent.htmlindex 0ddeb2753..41e2aefb6 100644--- a/site/public/docs/zh/intent.html+++ b/site/public/docs/zh/intent.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -326,6 +327,7 @@ The number of its kind (0 for none):</pre><a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/zh/masking.html b/site/public/docs/zh/masking.htmlnew file mode 100644index 000000000..01c5bd342--- /dev/null+++ b/site/public/docs/zh/masking.html@@ -0,0 +1,201 @@+<!doctype html>+<html lang="zh-CN">+<head>+<meta charset="utf-8">+<meta name="viewport" content="width=device-width, initial-scale=1">+<title>本地脱敏 · magpie 文档</title>+<meta name="description" content="怎么打开 magpie 的本地脱敏:请求离开电脑前会遮掉什么、回复里怎么还原、怎么确认生效,以及它的限制。">+<meta name="color-scheme" content="light dark">+<meta name="theme-color" content="#fafafa">+<script>+(() => {+ let mode = "system";+ try { mode = localStorage.getItem("theme") || "system"; } catch {}+ const q = matchMedia("(prefers-color-scheme: dark)");+ const apply = () => {+ const t = mode === "system" ? (q.matches ? "dark" : "light") : mode;+ document.documentElement.dataset.theme = t;+ document.querySelector('meta[name="theme-color"]').content = t === "dark" ? "#0b0b0c" : "#fafafa";+ document.querySelectorAll("button.theme").forEach((b) => { b.dataset.mode = mode; b.title = "Theme: " + mode; });+ };+ q.addEventListener("change", () => mode === "system" && apply());+ window.setTheme = (m) => { mode = m; try { m === "system" ? localStorage.removeItem("theme") : localStorage.setItem("theme", m); } catch {} apply(); };+ window.themeMode = () => mode;+ apply();+})();+</script>+<script>try{if(/Linux/.test(navigator.userAgent)&&!/Android/.test(navigator.userAgent)||localStorage.getItem("omarchy")||/[?&]omarchy=/.test(location.search))document.write('<script src="/omarchy.js"><\/script>')}catch(e){}</script>+<link rel="icon" href="/favicon.png" type="image/png">+<link rel="apple-touch-icon" href="/img/icon-256.png">+<link rel="alternate" hreflang="en" href="https://usemagpie.ai/docs/masking">+<link rel="alternate" hreflang="zh" href="https://usemagpie.ai/docs/zh/masking">+<link rel="alternate" hreflang="ja" href="https://usemagpie.ai/docs/ja/masking">+<link rel="stylesheet" href="/docs.css">+<meta property="og:title" content="本地脱敏">+<meta property="og:description" content="密钥、密码和个人信息留在你的电脑上:请求发出前脱敏,回复里还原。">+<meta property="og:image" content="https://usemagpie.ai/img/og.png">+<meta property="og:url" content="https://usemagpie.ai/docs/zh/masking">+<meta name="twitter:card" content="summary_large_image">+</head>+<body>++<nav><div class="wrap">+ <a class="brand" href="/zh/"><img class="bird" src="/img/magpie-small.svg" alt="">magpie <small>文档</small></a>+ <div class="links">+ <a href="/zh/">首页</a>+ <a href="/docs/zh/start">快速上手</a>+ <a href="/docs/zh/intent">意图路由</a>+ <a href="/docs/zh/plugins">插件开发</a>+ <a class="toc-only" href="/docs/zh/remote">远程 magpie</a>+ <a class="toc-only" href="/docs/zh/docker">Docker</a>+ <a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a>+ <a href="/docs/zh/import">Add to magpie</a>+ <a href="/docs/zh/integrate">接入应用</a>+ <a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>+ </div>+ <div class="langs">+ <button class="icon-btn lang" type="button" aria-label="语言" title="语言" aria-haspopup="true" aria-expanded="false" aria-controls="langs"><svg viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.4" aria-hidden="true"><circle cx="8" cy="8" r="6.25"/><path d="M1.75 8h12.5M8 1.75c1.7 1.75 2.55 3.83 2.55 6.25S9.7 12.5 8 14.25M8 1.75C6.3 3.5 5.45 5.58 5.45 8S6.3 12.5 8 14.25"/></svg></button>+ <div class="lang-menu" id="langs" hidden>+ <a href="/docs/masking" hreflang="en" lang="en">English</a>+ <a href="/docs/zh/masking" hreflang="zh" lang="zh">中文</a>+ <a href="/docs/ja/masking" hreflang="ja" lang="ja">日本語</a>+ </div>+ </div>+ <a class="icon-btn" href="https://discord.gg/vGSnD3ZKQF" aria-label="magpie on Discord" title="Join us on Discord"><svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true"><path d="M20.317 4.3698a19.7913 19.7913 0 00-4.8851-1.5152.0741.0741 0 00-.0785.0371c-.211.3753-.4447.8648-.6083 1.2495-1.8447-.2762-3.68-.2762-5.4868 0-.1636-.3933-.4058-.8742-.6177-1.2495a.077.077 0 00-.0785-.037 19.7363 19.7363 0 00-4.8852 1.515.0699.0699 0 00-.0321.0277C.5334 9.0458-.319 13.5799.0992 18.0578a.0824.0824 0 00.0312.0561c2.0528 1.5076 4.0413 2.4228 5.9929 3.0294a.0777.0777 0 00.0842-.0276c.4616-.6304.8731-1.2952 1.226-1.9942a.076.076 0 00-.0416-.1057c-.6528-.2476-1.2743-.5495-1.8722-.8923a.077.077 0 01-.0076-.1277c.1258-.0943.2517-.1923.3718-.2914a.0743.0743 0 01.0776-.0105c3.9278 1.7933 8.18 1.7933 12.0614 0a.0739.0739 0 01.0785.0095c.1202.099.246.1981.3728.2924a.077.077 0 01-.0066.1276 12.2986 12.2986 0 01-1.873.8914.0766.0766 0 00-.0407.1067c.3604.698.7719 1.3628 1.225 1.9932a.076.076 0 00.0842.0286c1.961-.6067 3.9495-1.5219 6.0023-3.0294a.077.077 0 00.0313-.0552c.5004-5.177-.8382-9.6739-3.5485-13.6604a.061.061 0 00-.0312-.0286zM8.02 15.3312c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9555-2.4189 2.157-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.9555 2.4189-2.1569 2.4189zm7.9748 0c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9554-2.4189 2.1569-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.946 2.4189-2.1568 2.4189Z"/></svg></a>+ <a class="icon-btn" href="https://github.com/yetone/magpie" aria-label="magpie on GitHub" title="Source on GitHub"><svg viewBox="0 0 16 16" fill="currentColor" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8Z"/></svg></a>+ <button class="icon-btn theme" type="button" aria-label="Theme" title="Theme: system"><svg class="i-system" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5"><rect x="1.75" y="2.75" width="12.5" height="8.5" rx="1.5"/><path d="M5.5 14h5M8 11.25V14"/></svg><svg class="i-light" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"><circle cx="8" cy="8" r="3"/><path d="M8 1v1.5M8 13.5V15M1 8h1.5M13.5 8H15M3 3l1 1M12 12l1 1M3 13l1-1M12 4l1-1"/></svg><svg class="i-dark" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linejoin="round"><path d="M13.5 9.5A5.5 5.5 0 0 1 6.5 2.5a5.5 5.5 0 1 0 7 7Z"/></svg></button>+ <a class="btn small" href="/#get">下载</a>+</div></nav>++<main class="wrap doc">+ <aside class="toc">+ <p>本地脱敏</p>+ <a href="#overview">概览</a>+ <a href="#on">打开它</a>+ <a href="#what">会遮掉什么</a>+ <a href="#example">一个例子</a>+ <a href="#check">怎么确认生效</a>+ <a href="#found">发现敏感值时</a>+ <a href="#limits">不处理的内容与限制</a>+ </aside>++ <article>+ <p class="eyebrow" id="overview">文档 · 本地脱敏</p>+ <h1>本地脱敏</h1>+ <p class="lede">magpie 可以在 Agent 发出的请求离开这台电脑之前先做脱敏。API Key、密码和 Token,以及你选择的邮箱、手机号和自定义词,会以 <code>{{API_KEY_es6eu6jk}}</code> 这样的占位符发给模型厂商;回复里的占位符再换回原值,所以 Agent 和你的文件里始终是真值,厂商看不到。脱敏在这台电脑上、在 magpie 的网关里完成,<b>默认关闭</b>。</p>++ <div class="callout"><b>只覆盖经过 magpie 的请求。</b><a href="/docs/zh/start">接入 magpie</a> 的 Agent 通过网关发请求,不管由哪个供应商或账号回答都会脱敏。绕过 magpie、直接请求厂商的 Agent 不在范围内。</div>++ <h2 id="on"><a class="anchor" href="#on">打开它</a></h2>+ <ol class="steps">+ <li><b>打开页面</b>进入 <span class="ui">设置</span> → <span class="ui">隐私</span>。</li>+ <li><b>脱敏密钥</b>在 <span class="ui">要遮什么</span> 下把 <span class="ui">脱敏密钥</span> 设为 <span class="ui">开启</span>:API Key、私钥、Token 和密码。</li>+ <li><b>个人信息(按需)</b>把 <span class="ui">脱敏个人信息</span> 设为 <span class="ui">开启</span>,邮箱、手机号、身份证号和银行卡号也一并脱敏。打开后,下面会列出其他各类个人信息,每类有自己的开关。</li>+ <li><b>自定义词</b>在 <span class="ui">脱敏词</span> 里填不想让厂商看到的人名、项目代号或主机名,用逗号分隔。<span class="ui">脱敏词不区分大小写</span> 打开后,<em>Nightjar</em> 也会遮掉 <em>NIGHTJAR</em>。magpie 不认识的密钥(比如你自己网关的 key)加到 <span class="ui">自定义脱敏规则</span>:填它的开头,或一个正则表达式。</li>+ <li><b>试一试</b>把一段文字粘到 <span class="ui">试一试</span>,就能看到厂商实际会收到什么。粘进去的内容不会保存。</li>+ </ol>+ <p>改动从下一个请求开始生效,不用重启,Agent 那边也不用改。实际做脱敏的是内置插件 <span class="ui">隐私遮盖</span>(<code>redact</code>,在 <span class="ui">设置</span> → <span class="ui">插件</span>),只要设置里要求了任何脱敏,它就是开着的。</p>+ <p>没有专门的命令行命令。没有窗口时(<code>magpie serve</code>、<a href="/docs/zh/docker">Docker</a>),可以用 <code>magpie web</code> 打开同一个页面,或者直接写 <code>~/.config/magpie/settings.json</code>(Docker 里是 <code>/config/magpie/settings.json</code>)。每个请求都会重新读这个文件:</p>+ <div class="code">+ <span class="lang">settings.json</span>+ <button class="copy" data-copy="ex-settings">复制</button>+ <pre id="ex-settings">{+ <span class="s">"redact"</span>: true,+ <span class="s">"redactPersonal"</span>: true,+ <span class="s">"redactWords"</span>: [<span class="s">"Nightjar"</span>, <span class="s">"db.acme-corp.cn"</span>]+}</pre>+ </div>++ <h2 id="what"><a class="anchor" href="#what">会遮掉什么</a></h2>+ <div class="table-wrap"><table>+ <tr><th>开关</th><th>能找到什么</th></tr>+ <tr><td><span class="ui">脱敏密钥</span></td><td>私钥块(<code>-----BEGIN … PRIVATE KEY-----</code>)。按格式识别的 API Key:<code>sk-…</code>(OpenAI、Anthropic、OpenRouter)、<code>ghp_</code>/<code>github_pat_</code>、<code>glpat-</code>、<code>AIza…</code>、<code>xox…-</code>、<code>sk_live_</code>、<code>AKIA</code>/<code>ASIA</code>、<code>hf_</code>、<code>gsk_</code>、<code>xai-</code>、<code>npm_</code>、<code>pypi-</code>、<code>dop_v1_</code>、<code>SG.</code>,以及 <code>oc_sk_…</code> 这类中转站的 key。JWT。<code>user:password@host</code> 里的密码。<code>.env</code> 和配置文件里以密钥命名的字段的值:<code>DB_PASSWORD=…</code>、<code>api_key: …</code>、<code>client_secret</code>、<code>token</code>、<code>credential</code>。以及你的 <span class="ui">自定义脱敏规则</span>。</td></tr>+ <tr><td><span class="ui">脱敏个人信息</span></td><td>邮箱、中国大陆手机号、校验位对得上的身份证号和银行卡号。默认也开着的:美国社会安全号、护照号(跟在 <em>passport</em>、护照或パスポート后面)、IBAN、生日(旁边有 <em>birthday</em>、<em>DOB</em> 或「生日」)、MAC 地址、序列号(跟在 <em>S/N</em> 后面)。默认关闭、需要自己打开的(Agent 几乎每个请求都会带):主目录里的用户名、用户名和主机名(<code>user@host</code>)、公网 IP 地址、云存储桶。</td></tr>+ <tr><td><span class="ui">脱敏词</span></td><td>你填的每个词,精确匹配,换成 <code>{{TERM_…}}</code>。</td></tr>+ <tr><td><span class="ui">用本地模型查找</span></td><td>在 <span class="ui">怎么找</span> 下面。一个在这台电脑上运行的模型(OpenAI 的 Privacy Filter,下载 1.6 GB)能找出规则找不到的东西:自由文本里的人名、地址。需要先打开 <span class="ui">脱敏密钥</span> 或 <span class="ui">脱敏个人信息</span>,找到的内容按同样的开关处理。</td></tr>+ </table></div>+ <p>占位符是「类型 + 8 位带密钥的哈希」。同一个值每次得到同一个占位符,所以对话每一轮读起来都一样,厂商的提示词缓存也不会失效。原值只保存在内存里。</p>++ <h2 id="example"><a class="anchor" href="#example">一个例子</a></h2>+ <p>打开 <span class="ui">脱敏密钥</span> 和 <span class="ui">脱敏个人信息</span>,并在 <span class="ui">脱敏词</span> 里填 <em>Nightjar</em>。Agent 发出:</p>+ <div class="code">+ <span class="lang">Agent 发出</span>+ <pre>Deploy Nightjar with OPENAI_API_KEY=sk-proj-8fK2mQx7Lp4Rt9Vw3Yz6Ab1Cd, then mail [email protected] or call 13800138000.</pre>+ </div>+ <div class="code">+ <span class="lang">厂商收到</span>+ <pre>Deploy {{TERM_5hmsrhdc}} with OPENAI_API_KEY={{API_KEY_srhjgvja}}, then mail {{EMAIL_eh5um6mb}} or call {{PHONE_uf7iy2qq}}.</pre>+ </div>+ <p>模型回复 <em>“我已在 .env 里把 OPENAI_API_KEY 设为 {{API_KEY_srhjgvja}}”</em> 时,Agent 读到的是真实的 key,流式文本和工具调用参数里都一样,所以它写进文件的也是真 key。模型把占位符稍微改了样子(花括号里加了空格、大小写变了)也照样能换回来。</p>++ <h2 id="check"><a class="anchor" href="#check">怎么确认生效</a></h2>+ <ul>+ <li><b>事前:</b><span class="ui">设置</span> → <span class="ui">隐私</span> 里的 <span class="ui">试一试</span> 会显示厂商收到的文本,以及每个值的类型。</li>+ <li><b>每个请求:</b>在 <span class="ui">网关</span> 页的最近调用和 <span class="ui">路由</span> 日志里,被脱敏的请求会带一个盾牌徽标和数字。鼠标指上去看类型,点开看这个请求的记录。</li>+ <li><b>一段时间:</b><span class="ui">观测</span> → <span class="ui">脱敏</span>(隐私页的 <span class="ui">脱敏记录</span> 也能进)按类型、Agent、供应商显示 7 天或 30 天里遮掉的值,以及每个请求在厂商眼里的原文,占位符会标出来。</li>+ </ul>+ <p>记录保存在 <code>~/.config/magpie/masking</code>,保留 30 天:Agent、供应商、模型,以及每个占位符的类型、长度和开头几个字符,从不保存原值。</p>++ <h2 id="found"><a class="anchor" href="#found">发现敏感值时</a></h2>+ <p>在 <span class="ui">发现敏感值时</span> 下,每种类型可以选:</p>+ <ul>+ <li><span class="ui">脱敏</span>(默认):换成占位符发出。</li>+ <li><span class="ui">提醒</span>:原样发出,徽标用琥珀色计数。</li>+ <li><span class="ui">拦截</span>:请求被拦下,返回 400:<em>“magpie held this request back: Settings › Privacy blocks API_KEY, and it has one (sk-…, 33 characters). Nothing was sent.”</em> 消息里不会出现原值。</li>+ </ul>+ <p>任务必须原样使用的值(团队邮箱、测试用的 key)加进 <span class="ui">从不脱敏</span>:只要整段匹配,就原样发出。</p>++ <h2 id="limits"><a class="anchor" href="#limits">不处理的内容与限制</a></h2>+ <ul>+ <li><b>思考内容保持厂商原样。</b>带签名的 thinking 块、Gemini 的 thoughts、Responses 的加密推理都由厂商签过名,原样发回,签名才对得上。里面只会替换请求其他地方已经遮掉的值。</li>+ <li><b>ID 和工具定义原样发送:</b>模型 ID、消息和调用 ID、UUID、工具名、MCP 服务名、工具 schema(其中的描述文字会脱敏),这样厂商和工具还能校验它们。</li>+ <li><b>图片和文件数据原样发送。</b>截图里的文字不会被遮。</li>+ <li><b>失败即不发送。</b>脱敏已打开却运行不了(手动关掉了 <span class="ui">隐私遮盖</span> 插件,或本地模型开着但没响应),请求返回 503,说明什么都没发出,绝不会退回成不脱敏直接发送。</li>+ <li><b>本地模型可以跳过。</b>供应商的每个地址都在本机或局域网(Ollama、LM Studio)时,打开它的 <span class="ui">请求不脱敏</span>,请求就原样发出;命令行是 <code>magpie provider set ollama unmasked=yes</code>。日志里保存的仍是脱敏后的内容。</li>+ <li><b>模型只看到占位符。</b>它无法读懂或推理被遮掉的值,只能原样传递。需要模型读的值放进 <span class="ui">从不脱敏</span>。</li>+ <li><b>规则按格式匹配。</b>其他国家格式的电话号码、自由文本里的人名,需要 <span class="ui">用本地模型查找</span>,或者自己的 <span class="ui">脱敏词</span> 和 <span class="ui">自定义脱敏规则</span>。先用 <span class="ui">试一试</span> 测一下你自己的文本。</li>+ </ul>+ <p>magpie 自己会发出什么,见 <a href="/docs/zh/privacy">隐私</a>。代码在 <a href="https://github.com/yetone/magpie/tree/main/internal/redact">internal/redact</a> 和 <a href="https://github.com/yetone/magpie/blob/main/internal/masking/masking.go">internal/masking</a>。</p>+ </article>+</main>++<footer><div class="wrap">+ <span>© 2026 magpie · MIT</span>+ <div class="links">+ <a href="/zh/">首页</a>+ <a href="/docs/zh/start">快速上手</a>+ <a href="/docs/zh/intent">意图路由</a>+ <a href="/docs/zh/plugins">插件开发</a>+ <a href="/docs/zh/remote">远程 magpie</a>+ <a href="/docs/zh/docker">Docker</a>+ <a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a>+ <a href="/docs/zh/import">Add to magpie</a>+ <a href="/docs/zh/integrate">接入应用</a>+ <a href="https://github.com/yetone/magpie">GitHub</a>+ <a href="https://discord.gg/vGSnD3ZKQF">Discord</a>+ <a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>+ </div>+</div></footer>++<script>+(() => {+ const next = { system: "light", light: "dark", dark: "system" };+ document.querySelectorAll("button.theme").forEach((b) => {+ b.dataset.mode = themeMode();+ b.title = "Theme: " + themeMode();+ b.addEventListener("click", () => setTheme(next[themeMode()]));+ });++ document.querySelectorAll(".copy").forEach((b) => b.addEventListener("click", async () => {+ try {+ await navigator.clipboard.writeText(document.getElementById(b.dataset.copy).textContent);+ b.textContent = "已复制"; setTimeout(() => (b.textContent = "复制"), 1400);+ } catch {}+ }));+})();+</script>+<script src="/docs.js"></script>+</body>+</html>diff --git a/site/public/docs/zh/plugins.html b/site/public/docs/zh/plugins.htmlindex 54ae61cf0..e5da154ec 100644--- a/site/public/docs/zh/plugins.html+++ b/site/public/docs/zh/plugins.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -960,6 +961,7 @@ document.getElementById(<span class="s">"calls"</span>).textContent = `${s.calls<a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/zh/privacy.html b/site/public/docs/zh/privacy.htmlindex 57d7c1b0d..b5efa65cb 100644--- a/site/public/docs/zh/privacy.html+++ b/site/public/docs/zh/privacy.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -197,6 +198,7 @@<li>原值只在内存里;磁盘上的记录只留每个值的类型、长度和开头几个字符。脱敏打开却运行不了时,请求返回 503,什么都不发。</li><li>模型看到的是占位符,不是值本身。任务需要原样使用的值(团队邮箱、测试用的 key)可以加进 <span class="ui">从不脱敏</span>。</li></ul>+ <p>怎么打开、每个开关遮掉什么、例子以及怎么确认生效,见 <a href="/docs/zh/masking">本地脱敏</a>。</p><h2 id="why"><a class="anchor" href="#why">为什么计数默认开启</a></h2><p>magpie 支持几十个 agent 和供应商,维护的人不多。每日计数让我们知道大家实际在用哪些,好先保证它们能用。正式版默认开启,是因为只靠主动开启的人,数量太少,看不出这些。作为交换,它尽量少:一个随机 ID、内置 ID 和数字;一个开关或 <code>DO_NOT_TRACK=1</code> 就能关掉,源码构建从不发送,发送的全部内容都列在这一页。</p>@@ -213,6 +215,7 @@<a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/zh/remote.html b/site/public/docs/zh/remote.htmlindex 9b90d5471..884b1beb5 100644--- a/site/public/docs/zh/remote.html+++ b/site/public/docs/zh/remote.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -155,6 +156,7 @@ magpie provider refresh office <span class="c"># 重新获取列表</span></pr<a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie">GitHub</a>diff --git a/site/public/docs/zh/start.html b/site/public/docs/zh/start.htmlindex bb2363fed..30dae0e76 100644--- a/site/public/docs/zh/start.html+++ b/site/public/docs/zh/start.html@@ -49,6 +49,7 @@<a class="toc-only" href="/docs/zh/remote">远程 magpie</a><a class="toc-only" href="/docs/zh/docker">Docker</a><a class="toc-only" href="/docs/zh/privacy">隐私</a>+ <a class="toc-only" href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie-releases/releases">版本发布</a>@@ -325,6 +326,7 @@ IP-CIDR6,::1/128,DIRECT,no-resolve</pre><a href="/docs/zh/remote">远程 magpie</a><a href="/docs/zh/docker">Docker</a><a href="/docs/zh/privacy">隐私</a>+ <a href="/docs/zh/masking">本地脱敏</a><a href="/docs/zh/import">Add to magpie</a><a href="/docs/zh/integrate">接入应用</a><a href="https://github.com/yetone/magpie">GitHub</a>