stump

机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

Stump 是一个免费的开源漫画、漫画书和电子书服务器，支持 OPDS，由 Rust、Axum、SeaORM 和 React 创建。

免责声明

Stump 正在积极开发中，在达到稳定的 1.0 版本之前应被视为测试版软件。我会尽力避免破坏性更改或可能导致数据丢失的更改，但不能保证。

我在空闲时间开发和维护 Stump。换句话说，这不是我的工作，因此无法保证功能或错误修复的任何时间表。

功能

• 支持 OPDS v1.2（包括 OPDS PSE）和 v2.0
• 支持 EPUB、PDF、CBZ/ZIP 和 CBR/RAR 格式
• 所有支持格式的内置阅读器
• EPUB 书籍的注释和高亮功能
• OIDC 认证
• 使用 Weblate 进行翻译
• 多用户账户管理，具有权限、年龄限制及其他访问控制功能
• 支持主题，提供少量 内置主题
• Kobo 和 KoReader 同步集成
• 多种不同的安装方法，包括 Docker 和预编译二进制文件

以及其他未提及的功能。详细功能、安装和使用指南请参见 文档。

路线图

您可以跟踪项目板来查看当前正在进行或计划的工作。

如果您还有其他想要看到的内容，请随时创建问题或讨论！

入门指南

安装指南可以在文档中查看（如果你更喜欢，也可以在Markdown中查看）。

开发者指南

开发者指南可以在文档（或者如果你愿意，可以在Markdown）中获取。为了避免维护两份相同的信息，请参考这些链接获取最新的信息。

贡献

非常欢迎贡献！在开始之前，请先查看 CONTRIBUTING.md。

我建议查看 开放问题。你也可以查看 项目看板，了解当前或计划中的工作。

总体来说，以下领域总是需要帮助：

• 通过 Weblate 进行翻译，使 Stump 对尽可能多的人可访问。
• 编写全面的测试
• 改进 UI/UX，即使是小的更改也会有很大帮助
• CI 管道、自动发布流程及其他与 DevOps 相关的工作
• 处理代码库中的 TODO 或 FIXME 评论

仓库结构

该仓库通过 yarn 工作区和 cargo 工作区进行管理：

# The primary applications all grouped together
apps/
  desktop/   # Tauri wrapping the web UI
  expo/      # React Native app
  server/    # Axum server
  web/       # UI served by the server
# The primary internals, like file processing etc
core/
# Supporting Rust crates (cli, graphql, integrations, etc)
crates/
  migrations/  # Database migrations
  models/      # Database models
docs/
# Shared TypeScript packages
packages/

翻译

类似项目

还有许多其他类似于 Stump 的项目，它当然不是第一个或唯一的数字书媒体服务器。如果 Stump 不适合你，或者你想了解这个领域的类似项目，这里有一些你可能感兴趣的其他项目：

• audiobookshelf（有声书，播客）
• Codex
• Kavita
• Komga
• 讲故事者

许可证

如果一个包或子文件夹有自己的许可证文件，则该许可证优先于仓库级别的许可证，并将在下面列出。

• expo 应用程序 获得 GPL-3.0 许可 (摘要)
• wifi-ssid 原生模块 来源于 Streamyfin，并获得 MPL-2.0 许可 (摘要)
• 仓库中的所有其他代码均获得 MIT 许可证 许可 (摘要)

归属

• 某些用于网页和移动应用程序的图标来自 Spacedrive 仓库，并根据 FSL-1.1-ALv2 许可协议授权。
• 本地 Readium expo 模块改编自 Storyteller