使用文档
快速了解 NekroEndpoint 平台的核心功能和使用方法
快速开始
- 1. 使用 GitHub 登录
点击顶部导航栏的 'GitHub 登录' 按钮，授权后自动创建账号
- 2. 创建第一个端点
进入「端点管理」页面，点击 '新建端点' 按钮开始创建
- 3. 配置端点内容
根据需求选择端点类型（静态内容、代理、脚本），填写配置信息
- 4. 发布端点（需激活）
保存后点击 '发布' 按钮，端点将通过 https://your-domain.com/e/your-username/your-path 访问
端点类型
静态端点
返回预定义的静态内容，适用于配置文件、JSON 数据、文本内容等场景。
第 1 步：创建端点
- 在端点管理页面点击「新建端点」
填写名称（如'Clash订阅'）和路径（如'/clash-config'）
- 端点类型选择「Static」
用于托管静态配置文件
- 访问控制选择「authenticated」
需要访问密钥才能访问，保护配置安全
第 2 步：配置内容
创建端点后，在右侧编辑器中：
- 1. 将 Content-Type 设为「text/yaml」
让 Clash 客户端正确识别配置格式
- 2. 在编辑器中粘贴你的 Clash 配置
支持语法高亮
- 3. 点击「保存」按钮
Clash 配置示例：
port: 7890
socks-port: 7891
allow-lan: true
mode: Rule
log-level: info
proxies:
- name: "US Server"
type: ss
server: us.example.com
port: 8388
cipher: aes-256-gcm
password: your-password
- name: "HK Server"
type: vmess
server: hk.example.com
port: 443
uuid: your-uuid
alterId: 0
cipher: auto第 3 步：生成访问密钥
在 Clash 客户端添加订阅：
https://your-domain.com/e/your-username/clash-config?access_key=ep-your-access-key
💡 更多实战案例
案例 2：API Mock 数据
创建端点，Content-Type 选择「application/json」，在编辑器中填写：
{
"code": 200,
"message": "success",
"data": {
"users": [
{"id": 1, "name": "Alice"},
{"id": 2, "name": "Bob"}
]
}
}快速搭建前端开发用的 Mock API，访问控制设为 public 即可公开访问
案例 3：HTML 公告页面
创建端点，Content-Type 选择「text/html」，在编辑器中填写：
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>系统维护通知</title> </head> <body> <h1>系统维护通知</h1> <p>将于今晚 22:00-24:00 进行系统升级</p> <p>升级期间服务暂时不可用，感谢理解</p> </body> </html>
发布 HTML 格式的通知页面，直接在浏览器访问
代理端点
转发请求到目标 URL，支持自定义请求头，适用于单文件代理、API 转发、资源加速等场景。
第 1 步：创建代理端点
- 在端点管理页面点击「新建端点」
填写名称（如'GitHub Release'）和路径（如'/gh-release'）
- 端点类型选择「Proxy」
用于转发请求到目标服务器
- 访问控制选择「public」
允许公开访问
第 2 步：配置代理参数
创建端点后，在右侧配置表单中填写：
- 目标 URL
https://api.github.com/repos/anthropics/anthropic-sdk-python/releases/latest
- 超时时间
15000 毫秒（15秒）
- 请求头（可选）
点击「添加」按钮，添加 Header：Accept = application/vnd.github+json
第 3 步：发布并使用
保存后点击「发布」，然后访问：
curl https://your-domain.com/e/your-username/gh-release
💡 更多实战案例
案例 2：隐藏第三方 API 密钥
将 API Key 直接包含在目标 URL 中，客户端无需知道密钥：
- 目标 URL
https://api.weatherapi.com/v1/current.json?key=your-api-key&q=Beijing
前端直接访问你的代理端点，API 密钥不会暴露在客户端代码中
案例 3：代理单个图片资源
为特定图片创建代理端点（如 /my-avatar）：
- 目标 URL
https://example.com/images/avatar.jpg
- 超时时间
20000 毫秒（图片可能较大）
通过边缘节点加速图片访问，每个图片需创建独立端点
动态代理端点 ⭐ 新功能
将所有子路径请求动态拼接到基础 URL 后进行转发，适用于代理整个目录、仓库资源、API 命名空间等场景。
第 1 步：创建动态代理端点
- 在端点管理页面点击「新建端点」
填写名称（如'我的仓库'）和路径（如'/myrepo'）
- 端点类型选择「Dynamic Proxy」
用于动态转发子路径请求
- 访问控制选择「public」
允许公开访问
第 2 步：配置基础 URL
创建端点后，在右侧配置表单中填写：
- 基础 URL
https://raw.githubusercontent.com/yourusername/yourrepo/main/
- 自动补充斜杠
开启（确保 URL 拼接正确）
- 超时时间
15000 毫秒（15秒）
第 3 步：发布并使用
保存后点击「发布」，然后访问任意子路径：
# 访问 README.md curl https://your-domain.com/e/your-username/myrepo/README.md # 访问 assets 目录下的图片 curl https://your-domain.com/e/your-username/myrepo/assets/logo.png # 访问 docs 目录下的文档 curl https://your-domain.com/e/your-username/myrepo/docs/guide.md
💡 更多实战案例
案例 2：代理 CDN 资源目录
配置基础 URL 为 CDN 目录：
- 基础 URL
https://cdn.example.com/assets/
访问示例：
# 访问 CSS 文件 https://your-domain.com/e/your-username/cdn/styles/main.css # 访问 JS 文件 https://your-domain.com/e/your-username/cdn/scripts/app.js # 访问图片 https://your-domain.com/e/your-username/cdn/images/banner.jpg
案例 3：代理 API 命名空间
配置基础 URL 为 API 基础路径：
- 基础 URL
https://api.example.com/v1/
- 路径白名单（可选）
添加 /users/*, /posts/* 限制可访问的 API 端点
访问示例：
# 访问用户列表 curl https://your-domain.com/e/your-username/api/users # 访问用户详情 curl https://your-domain.com/e/your-username/api/users/123 # 访问文章列表 curl https://your-domain.com/e/your-username/api/posts
📊 与普通代理端点的对比
• 一个端点 → 一个固定 URL
• 适合代理单个资源或 API 端点
• 可以有子端点
动态代理端点（Dynamic Proxy）：
• 一个端点 → 整个目录/命名空间
• 适合代理多个资源或整个 API
• 不能有子端点（叶子节点）
• 子路径自动拼接到基础 URL
脚本端点（计划中）
在边缘节点运行自定义 JavaScript 代码，实现动态逻辑处理。
权限控制
通过权限组和访问密钥系统，实现端点的细粒度访问控制。
工作流程
- 1. 创建权限组
在「权限组」页面创建权限组，如 'VIP 用户'、'免费试用' 等
- 2. 生成访问密钥
为权限组生成访问密钥（格式：ep-xxxxxxxx），支持设置到期时间和备注
- 3. 端点关联权限组
编辑端点时，将访问控制设为 'authenticated'，并选择所需权限组
- 4. 客户端携带密钥访问
通过 HTTP Header 或 Query 参数传递访问密钥
客户端访问示例
方式一：HTTP Header
curl -H "X-Access-Key: ep-your-access-key" \ https://your-domain.com/e/your-username/endpoint-path
方式二：Query 参数
curl "https://your-domain.com/e/your-username/endpoint-path?access_key=ep-your-access-key"
端点访问
已发布的端点通过统一的 URL 格式访问：
https://your-domain.com/e/{username}/{endpoint-path}- username
你的用户名（GitHub 用户名）
- endpoint-path
端点的路径，如 /clash-config 或 /api/data
管理员功能
用户管理
- 激活用户
允许用户发布端点到公网，使其可被访问
- 停用用户
该用户所有端点将立即无法访问（可逆操作）
- 删除用户
永久删除用户及其所有数据（不可逆，谨慎操作）
内容审查 (计划中)
- 查看用户端点
查看任意用户的所有端点及其配置
- 强制下线端点
将违规端点强制设为未发布状态
常见问题
Q: 为什么我无法发布端点？
新注册用户默认未激活，需要联系管理员激活账号后才能发布端点。激活前可以正常创建和编辑端点。
Q: 代理端点支持哪些请求方法？
支持所有 HTTP 方法（GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS 等），请求体和请求头会被转发到目标 URL。
Q: 如何成为管理员？
首次部署后，访问 /init 页面可设置第一个管理员。之后该页面会被禁用，只能由现有管理员在管理后台手动变更用户角色。
Q: 普通代理和动态代理有什么区别？
普通代理（Proxy）：一个端点对应一个固定的目标 URL，适合代理单个资源。
动态代理（Dynamic Proxy）：一个端点可以代理整个目录或命名空间，所有子路径请求会自动拼接到基础 URL 后转发，适合代理多个资源。
Q: 为什么动态代理端点不能有子端点？
动态代理端点会处理所有子路径请求，如果允许创建子端点，会导致路径冲突和逻辑混乱。因此系统强制要求动态代理端点必须是叶子节点（无子端点）。
Q: 动态代理的路径白名单如何使用？
路径白名单用于限制可以访问的路径范围，支持通配符 *。例如：
• /repos/* - 允许访问所有以 /repos/ 开头的路径
• /users/*/profile - 允许访问特定模式的路径
留空则允许访问所有路径。建议为公开的动态代理端点配置白名单以提高安全性。
Q: 端点访问有速率限制吗？
目前暂无速率限制，但建议合理使用。未来可能会根据实际情况添加限流机制。