add security & privacy FAQ section

This commit is contained in:
romgX
2026-03-29 20:48:01 +08:00
parent b6f866e025
commit d5a6e9df88
2 changed files with 58 additions and 4 deletions

View File

@@ -11,7 +11,8 @@
3. [Providers & Quotas](#providers--quotas)
4. [Error Troubleshooting](#error-troubleshooting)
5. [IDE Integration](#ide-integration)
6. [LINUX DO Connect](#linux-do-connect)
6. [Security & Privacy](#security--privacy)
7. [LINUX DO Connect](#linux-do-connect)
---
@@ -258,6 +259,32 @@ To delete all data: `rm -rf ~/.openrelay/`
---
## Security & Privacy
### Q: Will using OpenRelay get my account banned?
No. OpenRelay is fundamentally different from a "reverse proxy":
- **Reverse proxy**: Your requests go through someone else's server, multiple users share one API key — providers can detect this and ban the account.
- **OpenRelay**: Runs entirely on your local machine. Requests go directly from your computer to the AI provider, exactly the same as calling the API yourself. The provider sees a normal user using their own quota — there's nothing to flag or ban.
In short: OpenRelay just manages and routes requests locally. It doesn't touch your account and nothing passes through any middleman server.
The only thing to keep in mind: if a provider changes their free tier policy (e.g., removes free credits), that's the provider's decision and has nothing to do with OpenRelay. When that happens, OpenRelay automatically switches to another provider that still has quota available.
### Q: Are my API keys / tokens safe? Could they be uploaded?
Absolutely safe. OpenRelay's security design:
1. **Credentials never leave your machine** — All API keys, tokens, and cookies stay in local process memory. Nothing is uploaded anywhere.
2. **Direct connections only** — Requests go straight from your machine to the AI provider. No third-party server in between.
3. **No chat logging** — Logs only contain errors and request metadata (provider, model, status code). Your conversation content is never logged or cached.
4. **Auditable code** — The credential handling code (`cookie.ts`) is open for review. You can check it yourself if you have any concerns.
Your data is stored only in `~/.openrelay/config.json`. To delete everything: `rm -rf ~/.openrelay/`.
---
## LINUX DO Connect
### Q: What does LINUX DO login do?
@@ -270,6 +297,6 @@ No. LINUX DO login is completely independent from OpenRelay's registration and P
---
> Last updated: 2026-03-28
> Last updated: 2026-03-29
>
> If your question isn't listed here, please open a [GitHub Issue](https://github.com/romgX/openrelay/issues) and we'll add it to this FAQ.

31
faq.md
View File

@@ -11,7 +11,8 @@
3. [Provider 与配额](#provider-与配额)
4. [报错排查](#报错排查)
5. [IDE 集成](#ide-集成)
6. [LINUX DO Connect](#linux-do-connect)
6. [安全与隐私](#安全与隐私)
7. [LINUX DO Connect](#linux-do-connect)
---
@@ -258,6 +259,32 @@ Kiro 的 AWS Token 约 1 小时过期。解决方法:
---
## 安全与隐私
### Q: 用 OpenRelay 会不会被封号?
不会。OpenRelay 跟"反代"(反向代理)完全不同:
- **反代**:你的请求经过别人的服务器,多人共用一个 Key容易被 Provider 检测到异常然后封号。
- **OpenRelay**:纯本地运行,请求从你自己的电脑直接发到 AI Provider跟你手动调 API 没有任何区别。Provider 看到的就是一个正常用户在用自己的配额,不存在封号风险。
简单说OpenRelay 只是帮你在本地管理和转发请求,不碰你的账号,不经过任何中间服务器。
唯一需要注意的是:如果某个 Provider 自己调整了免费额度政策(比如取消免费 tier那是 Provider 的决定,跟用不用 OpenRelay 无关。这种情况下 OpenRelay 会自动切换到其他还有额度的 Provider不影响使用。
### Q: 我的 API Key / Token 安全吗?会不会被上传?
绝对不会。OpenRelay 的安全设计:
1. **凭据不离开本机** — 所有 API Key、Token、Cookie 只在你电脑的本地内存中使用,不会上传到任何地方。
2. **直连 AI 后端** — 请求从你的机器直接发到 AI Provider中间没有任何第三方服务器。
3. **不记录聊天内容** — 日志只包含错误信息和请求元数据(哪个 Provider、哪个模型、状态码你的对话内容从不被记录或缓存。
4. **代码可审计** — 凭据处理的核心代码(`cookie.ts`)公开可查,不放心可以自己看。
你的数据只存在 `~/.openrelay/config.json` 里,想彻底删除执行 `rm -rf ~/.openrelay/` 即可。
---
## LINUX DO Connect
### Q: LINUX DO 登录有什么用?
@@ -270,6 +297,6 @@ Kiro 的 AWS Token 约 1 小时过期。解决方法:
---
> 最后更新2026-03-28
> 最后更新2026-03-29
>
> 如果你的问题不在列表中,请到 [GitHub Issues](https://github.com/romgX/openrelay/issues) 提问,我们会及时补充到本文档。