octoboxio/octobox

Octobox 镜像文档

镜像概述和主要用途

Octobox是一款专为GitHub通知管理设计的工具，旨在解决GitHub原生通知系统中"已读即消失"的痛点。它通过添加额外的归档状态，让用户能够明确标记通知为"已完成"，同时在相关线程有新活动时自动将其移回收件箱，确保重要通知不会被遗漏。Octobox还提供增强的通知信息展示、多维度筛选、键盘快捷键等功能，帮助用户更高效地处理通知，减少管理成本，专注于实际任务。

核心功能和特性

• 归档状态管理：为每个通知添加"归档"状态，标记为"已完成"；当归档的线程、Issue或PR有新活动时，会自动移回收件箱，避免错过更新。

• 星标通知：支持为重要通知添加星标，方便快速查找和跟进关键内容，无需在大量通知中筛选。

• 增强通知信息：展示比原生通知更丰富的内容，包括Issue/PR状态、CI构建状态、标签等，同时保留标题、组织、仓库和类型等基础信息，提供完整上下文。

• 多维度筛选：可按仓库、组织、通知类型、操作、状态、CI状态、原因等筛选，支持整合机器人通知与常规标签、作者、指派者信息，精准定位所需通知。

• 前缀搜索筛选：支持组合多种搜索筛选条件，无需复杂操作即可快速找到目标通知，提升查找效率。

• 键盘快捷键支持：采用类Gmail的键盘快捷键，覆盖导航、分类、管理等所有功能，无需鼠标即可高效操作，适合习惯键盘工作流的用户。

• 完全开源：100%开源开发，代码托管于GitHub，基于FLOSS许可，开发者使用Octobox自身进行开发管理，透明且社区驱动。

使用场景和适用范围

Octobox适用于以下用户和场景：

• GitHub项目维护者：需处理大量Issue、PR通知，需要跟踪哪些通知尚未跟进的用户，解决原生通知"已读后消失"的管理难题。

• 开源贡献者：参与多个项目，需要高效区分不同仓库、组织通知优先级的开发者，通过筛选功能聚焦关键任务。

• 避免邮件管理通知的用户：希望摆脱依赖Gmail等邮件客户端管理GitHub通知的用户，提供独立、专注的通知管理界面。

• 追求高效工作流的用户：习惯键盘操作、需要快速分类和处理通知的用户，通过快捷键和筛选功能减少操作步骤。

详细使用方法和配置说明

自托管部署（Docker）

用户可通过Docker自行部署Octobox，具体配置细节请参考官方安装指南，基本步骤如下：

1. 拉取镜像

   bash
   docker pull docker.xuanyuan.run/octoboxio/octobox
   

2. 运行容器（需根据实际需求配置环境变量，如数据库连接、GitHub OAuth密钥等，详细配置见官方安装文档）：

   bash
   docker run -d -p 3000:3000 --name octobox docker.xuanyuan.run/octoboxio/octobox
   

3. 访问与配置：打开浏览器访问 http://localhost:3000，按照指引完成GitHub OAuth授权，即可开始同步和管理通知。

桌面应用使用

可通过Nativefier将Octobox转换为本地桌面应用，步骤如下：

bash
# 安装Nativefier（需Node.js环境）
npm install -g nativefier

# 生成桌面应用（替换为自托管URL或官方地址）
nativefier "https://octobox.io"  # 或自托管实例URL，如"http://localhost:3000"

生成的应用（.exe、.app等）将位于当前目录，双击即可启动本地桌面版Octobox。

浏览器扩展

安装跨浏览器的https://github.com/tfrommen/octobox-web-extension%EF%BC%8C%E6%94%AF%E6%8C%81%EF%BC%9A

• https://chrome.google.com/webstore/detail/octobox-web-extension/efhkcafmbonnomnimilnephjgeccffdn
• https://addons.mozilla.org/en-US/firefox/addon/octobox-web-extension/
• 其他支持Web Extension标准的浏览器（如Edge、Brave等）

配置要求

使用Octobox前，需确保GitHub账户中启用https://github.com/settings/notifications%EF%BC%8C%E6%AD%A5%E9%AA%A4%E5%A6%82%E4%B8%8B%EF%BC%9A

1. 访问GitHub设置中的"通知"页面
2. 启用"Web通知"（推荐同时启用"漏洞通知"以接收安全相关更新）

键盘快捷键

Octobox支持以下键盘快捷键（按 ? 可查看完整列表）：

贡献与许可

贡献指南

Octobox欢迎社区贡献，源代码托管于https://github.com/octobox/octobox%EF%BC%8C%E8%B4%A1%E7%8C%AE%E6%96%B9%E5%BC%8F%E5%8C%85%E6%8B%AC%EF%BC%9A

• 提交Issue报告问题或需求
• 提交Pull Request（建议使用主题分支，添加测试用例）
• 参与问题分类和测试，关注https://github.com/octobox/octobox/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22%E7%9A%84%E4%BB%BB%E5%8A%A1

安全与行为准则

• 漏洞披露：遵循漏洞披露政策，鼓励安全研究和负责任的漏洞报告。
• 行为准则：参与者需遵守贡献者行为准则，确保社区友好、包容的氛围。

版权与许可

Octobox基于GNU Affero通用公共许可证开源，© 2018 Andrew Nesbitt。