ncarlier/keeper-core-api
ncarlier
自动构建
Nunux Keeper核心API是个人内容收藏服务的核心系统，支持收集、组织、检索在线文档，提供全文搜索、标签分类、文档分享及导入导出等功能。
2 次收藏下载次数: 0状态：自动构建维护者：ncarlier仓库类型：镜像最近更新：5 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Keeper core API
你的个人内容收藏服务。
该项目是Nunux Keeper的核心系统，是一个允许用户收集、组织和检索在线文档的API。
核心功能
- 创建文本/HTML文档（从零开始、从URL或上传文件）
- 清理网页以提升可读性
- 编辑文档内容
- 为文档附加文件
- 文档全文搜索
- 创建标签（名称、颜色）
- 用标签分类文档
- 删除与恢复文档
- 与其他用户或公开分享文档
- 通过RSS公开文档
- 导入/导出用户文档
- RESTful API（支持HATOAS）
- 委托外部身份提供者认证（如Keycloak、Auth0）
- 磁盘或S3存储附件
- 在线API文档
- 生成指标（支持StatsD）
- 向外部系统发布事件（Webhooks、AMQP等）
- BDD测试（支持Cucumber）
查看ROADMAP.md了解计划功能。
底层技术
基于Node.js开发，采用Express框架。后端存储可插拔（支持MongoDB/Elasticsearch，计划扩展其他存储），索引引擎可插拔（当前仅支持Elasticsearch），Redis用作服务间事件总线。
配置说明
前提条件
- Docker
- Docker Compose
运行测试
bash# 启动后端服务+测试+拆除 make build deploy test undeploy # 使用Elasticsearch作为主数据库测试 make build deploy with-elastic test undeploy
启动服务器
bash# 开发环境启动（含后端+API） make with-app deploy logs # 切换环境（如staging） make with-app deploy env=staging # 销毁所有服务 make undeploy
安装为系统服务
确保后端服务以mongodb/elasticSearch/redis名称运行：
bash# 安装staging环境的systemd配置 make install env=staging # 卸载 make uninstall
启动的服务：
- keeper-core-api：核心API服务器
- keeper-core-job-worker：后台任务worker
- keeper-data-backup：文档备份调度程序
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 keeper-core-api 镜像标签
docker pull docker.xuanyuan.run/ncarlier/keeper-core-api:<标签>
DockerHub 原生拉取命令
docker pull ncarlier/keeper-core-api:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"