An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作
TypeScript agentic-aiai-agentknowledge-baselocal-firstmarkdownmcpmindmapnote-takingself-hostedsiyuanworkspace
docs: sync OIDC Docker section into Chinese/Japanese/Turkish READMEs (#20540)
xuand64bb95e427a
diff --git a/README.ja.md b/README.ja.mdindex 40d6ef9e5f..56280bae2a 100644--- a/README.ja.md+++ b/README.ja.md@@ -217,6 +217,14 @@ docker run -d \- `accessAuthCode`: ロック画面パスワード(**必ず変更してください**、そうしないと誰でもデータにアクセスできます)- また、`SIYUAN_ACCESS_AUTH_CODE` 環境変数を設定することでロック画面パスワードを指定することもできます。両方が設定されている場合、コマンドラインの値が優先されます- 環境変数 `SIYUAN_ACCESS_AUTH_CODE_BYPASS=true` を設定することで、ロック画面パスワードを無効にすることができます+- OIDC はロック画面パスワードの代わりに Docker アクセス認証として利用できます。`SIYUAN_OIDC_ENABLED=true`、`SIYUAN_OIDC_PROVIDER`(`custom`、`google`、`microsoft`、`github` のいずれか)、`SIYUAN_OIDC_CLIENT_ID`、および以下のプロバイダー固有の値を設定してください。GitHub は OAuth 2.0 ユーザー API アダプターを使用し、その他のプロバイダーは OpenID Connect ディスカバリーと ID Token 検証を使用します。ロック画面パスワードが利用できない状態で無効な構成を有効にすると、Docker の起動が中断されます+ - `SIYUAN_OIDC_ISSUER_URL`:`custom` および `microsoft` プロバイダーに必要な Issuer URL。Microsoft は `https://login.microsoftonline.com/<tenant-id>/v2.0` のようなテナント固有の issuer を使用する必要があります+ - `SIYUAN_OIDC_CLIENT_SECRET`:OpenID Connect プロバイダー向けの任意のクライアントシークレット。GitHub OAuth アダプターでは必須です。すべての認可コードフローで PKCE を使用します+ - `SIYUAN_OIDC_SCOPES`:カンマまたはスペース区切りのスコープ。`openid` は常に含まれます+ - `SIYUAN_OIDC_REDIRECT_URL`:`/api/system/oidc/callback` で終わる公開 HTTPS コールバック URL。リモートブラウザーアクセスに必須です+ - `SIYUAN_OIDC_ALLOW_ALL`:プロバイダーで認証されたすべての ID に SiYuan 管理者アクセスを明示的に付与します+ - `SIYUAN_OIDC_CLAIM_RULES`:allow-all が無効な場合に使用するクレームルールの JSON 配列。例:`[{"claim":"email","operator":"equals","values":["[email protected]"]},{"claim":"email_verified","operator":"equals","values":["true"]}]`。ルール内の値は OR、ルール間は AND で評価されます+ - ネイティブモバイルアプリは固定のコールバック URI `siyuan:/oidc-callback` を使用します。記載どおりに登録してください。モバイル構成の検証は保存前にこのコールバックを使用します。カスタムプロバイダー、Microsoft、GitHub は、アプリ登録がこのコールバック URI を受け入れる場合にのみ使用できます。Google は Android クライアントタイプでこのプライベート URI を受け付けないため、Google ログインはブラウザーおよびデスクトップフローに限定されます- `SIYUAN_LANG`:インターフェース言語(オプション、Docker で未設定の場合はデフォルト `en`)。BCP 47 タグ(`zh-CN`/`zh-TW`/`en`/`ja`/`pt-BR` など)を受け付けます。従来のアンダースコア形式(`zh_CN`/`en_US` など)も互換性のため受け付けます。**設定**で選択した言語を再起動後も維持したい場合は、デプロイ時にこの変数を省略してください。設定した場合は起動のたびに適用され、保存済みの言語設定を上書きします- あるいは `--lang` コマンドライン引数でも設定できます。両方が設定されている場合、コマンドラインの値が優先されますdiff --git a/README.tr.md b/README.tr.mdindex 03f577f364..eac78443cf 100644--- a/README.tr.md+++ b/README.tr.md@@ -217,7 +217,15 @@ docker run -d \- Alternatif olarak, bu yol `SIYUAN_WORKSPACE_PATH` ortam değişkeniyle de ayarlanabilir. Eğer her iki yöntem de kullanılırsa, **komut satırı önceliklidir**.- `accessAuthCode`: Ekran kilidi şifresi (**kesinlikle değiştir**, aksi halde herkes verilerine erişebilir)- Alternatif olarak, ekran kilidi şifresi `SIYUAN_ACCESS_AUTH_CODE` ortam değişkeniyle de ayarlanabilir. Yine, hem komut satırı hem ortam değişkeni kullanılırsa, **komut satırı önceliklidir**.- - Ekran kilidi şifresini devre dışı bırakmak için şu ortam değişkenini ayarla: `SIYUAN_ACCESS_AUTH_CODE_BYPASS=true`+ - Ekran kilidi şifresini devre dışı bırakmak için şu ortam değişkenini ayarla: `SIYUAN_ACCESS_AUTH_CODE_BYPASS=true`+- OIDC, gerekli Docker erişim kimlik doğrulaması için ekran kilidi şifresinin yerini alabilir. `SIYUAN_OIDC_ENABLED=true`, `SIYUAN_OIDC_PROVIDER` (`custom`, `google`, `microsoft` veya `github`), `SIYUAN_OIDC_CLIENT_ID` ve aşağıdaki sağlayıcıya özgü değerleri ayarlayın. GitHub, OAuth 2.0 kullanıcı API bağdaştırıcısını kullanır; diğer sağlayıcılar OpenID Connect discovery ve ID Token doğrulaması kullanır. Kullanılabilir bir ekran kilidi şifresi yokken geçersiz bir etkin yapılandırma, Docker'ın başlangıcını durdurur+ - `SIYUAN_OIDC_ISSUER_URL`: `custom` ve `microsoft` sağlayıcıları için gereken Issuer URL'si; Microsoft, `https://login.microsoftonline.com/<tenant-id>/v2.0` gibi kiracıya özgü bir issuer kullanmalıdır+ - `SIYUAN_OIDC_CLIENT_SECRET`: OpenID Connect sağlayıcıları için isteğe bağlı istemci sırrı; GitHub OAuth bağdaştırıcısı için gereklidir. Her yetkilendirme kodu akışı PKCE kullanır+ - `SIYUAN_OIDC_SCOPES`: Virgül veya boşlukla ayrılmış kapsamlar; `openid` her zaman dahildir+ - `SIYUAN_OIDC_REDIRECT_URL`: `/api/system/oidc/callback` ile biten genel HTTPS geri çağırma URL'si; uzak tarayıcı erişimi için gereklidir+ - `SIYUAN_OIDC_ALLOW_ALL`: Sağlayıcı tarafından kimliği doğrulanan her kimliğe SiYuan yönetici erişimini açıkça verir+ - `SIYUAN_OIDC_CLAIM_RULES`: allow-all devre dışı bırakıldığında kullanılan talep kuralları JSON dizisi, örneğin `[{"claim":"email","operator":"equals","values":["[email protected]"]},{"claim":"email_verified","operator":"equals","values":["true"]}]`; bir kural içindeki değerler VEYA (OR), kurallar arasında VE (AND) olarak değerlendirilir+ - Yerel mobil uygulamalar sabit geri çağırma URI'si `siyuan:/oidc-callback` kullanır; tam olarak yazıldığı gibi kaydedin. Mobil yapılandırma doğrulaması, kaydetmeden önce bu geri çağırmayı kullanır. Özel sağlayıcılar, Microsoft ve GitHub yalnızca uygulama kayıtları bu geri çağırma URI'sini kabul ediyorsa kullanılabilir. Google, Android istemci türü için bu özel URI'yi kabul etmez; bu nedenle Google girişi tarayıcı ve masaüstü akışlarıyla sınırlıdır- `SIYUAN_LANG`: Arayüz dili (isteğe bağlı, Docker'da ayarlanmazsa varsayılan `en`). BCP 47 etiketlerini (`zh-CN`/`zh-TW`/`en`/`ja`/`pt-BR` vb.) kabul eder; eski alt çizgi biçimi (`zh_CN`/`en_US` vb.) de geriye dönük uyumluluk için kabul edilir. **Ayarlar**'da seçtiğin dilin yeniden başlatma sonrası da geçerli kalmasını istiyorsan dağıtımda bu değişkeni ekleme; ayarlanırsa her başlatmada uygulanır ve kaydedilmiş dil ayarının üzerine yazar- Alternatif olarak `--lang` komut satırı parametresiyle de ayarlanabilir. Her ikisi de ayarlanırsa komut satırı öncelikli olurdiff --git a/README.zh-CN.md b/README.zh-CN.mdindex ab63b87e3f..a94251767f 100644--- a/README.zh-CN.md+++ b/README.zh-CN.md@@ -222,6 +222,14 @@ docker run -d \- `accessAuthCode`:锁屏密码,请**务必修改**,否则任何人都可以读写你的数据- 另外,也可以通过 `SIYUAN_ACCESS_AUTH_CODE` 环境变量设置锁屏密码。如果两者都设置了,命令行的值将优先- 可通过设置环境变量 `SIYUAN_ACCESS_AUTH_CODE_BYPASS=true` 禁用锁屏密码+- OIDC 可替代锁屏密码作为 Docker 访问鉴权。设置 `SIYUAN_OIDC_ENABLED=true`、`SIYUAN_OIDC_PROVIDER`(`custom`、`google`、`microsoft` 或 `github`)、`SIYUAN_OIDC_CLIENT_ID` 以及下方的提供商相关配置。GitHub 使用其 OAuth 2.0 用户 API 适配器;其余提供商使用 OpenID Connect 发现与 ID Token 校验。在已启用 OIDC 且配置无效、又没有锁屏密码可用时,Docker 启动会直接终止+ - `SIYUAN_OIDC_ISSUER_URL`:`custom` 和 `microsoft` 提供商所需的 Issuer URL;Microsoft 必须使用租户专属的 issuer,例如 `https://login.microsoftonline.com/<tenant-id>/v2.0`+ - `SIYUAN_OIDC_CLIENT_SECRET`:OpenID Connect 提供商可选的客户端密钥;GitHub OAuth 适配器必须提供。所有授权码流程均使用 PKCE+ - `SIYUAN_OIDC_SCOPES`:逗号或空格分隔的 scopes;始终包含 `openid`+ - `SIYUAN_OIDC_REDIRECT_URL`:以 `/api/system/oidc/callback` 结尾的公网 HTTPS 回调 URL,远程浏览器访问时必填+ - `SIYUAN_OIDC_ALLOW_ALL`:明确授予提供商认证的所有身份 SiYuan 管理员权限+ - `SIYUAN_OIDC_CLAIM_RULES`:禁用 allow-all 时使用的声明规则 JSON 数组,例如 `[{"claim":"email","operator":"equals","values":["[email protected]"]},{"claim":"email_verified","operator":"equals","values":["true"]}]`;规则内取值为 OR,规则之间为 AND+ - 原生移动应用使用固定的回调 URI `siyuan:/oidc-callback`;请按原样注册。移动端配置在保存前会使用该回调进行校验。自定义提供商、Microsoft 和 GitHub 仅在其应用注册接受该回调 URI 时可用;Google 的 Android 客户端类型不接受该私有 URI,因此 Google 登录仅限浏览器和桌面端流程- `SIYUAN_LANG`:界面语言(可选,Docker 下未设置时默认为 `en`)。接受 BCP 47 标签如 `zh-CN`/`zh-TW`/`en`/`ja`/`pt-BR`;旧下划线值如 `zh_CN`/`en_US` 也兼容。若希望**设置**中选择的语言在重启后仍生效,部署时请去掉该变量;若设置了,每次启动都会应用该值并覆盖已保存的语言设置- 也可通过 `--lang` 命令行参数设置。如果两者都设置了,命令行的值将优先