comigo

功能特点

• 📚 多格式支持：支持图片文件夹与 .rar、.zip、.tar、.cbz、.cbr、.epub 等压缩包格式
• 📱 便捷访问：支持手机/平板扫描二维码阅读，Windows 支持拖拽打开
• 🐧 跨平台支持：适配 Windows、Linux、MacOS 系统
• 📖 多样化阅读模式：提供卷轴、翻页等多种阅读模式
• ⚙️ 灵活配置：支持命令行操作，可通过 config.toml 配置文件设定书库
• 🖼️ 现代图片格式：除了常见的jpg、png，还支持 heic、avif 等新一代图片格式
• ✂️ 智能优化：支持图片自动裁边，压缩图片节省流量
• 🔄 同步阅读：支持不同设备间同步翻页进度
• 🔌 插件系统：支持自动翻页、时钟等插件，可扩展自定义插件
• 🎬 媒体播放：内置音频、视频播放器
• 📥 灵活下载：支持打包下载图片文件夹，支持转换并下载为 EPUB 格式
• 📜 阅读历史：自动记录阅读历史，方便续读

安装指南

托盘版（推荐）

💡 说明：托盘版提供系统托盘图标，可最小化到后台运行。 Windows 用户双击运行即可，macOS 用户需要将APP拖入 应用程序 文件夹。

一键安装(命令行版)

# 中国大陆用户推荐使用中转脚本：
bash <(curl -s https://comigo.xyz/get.sh) --cn

# 从 GitHub下载：
bash <(curl -s https://raw.githubusercontent.com/yumenaka/comigo/master/get.sh)

# 如果您已设置 Golang 环境：
go install github.com/yumenaka/comigo/cmd/comi@latest

下载命令行版

💡 说明：命令行版适合服务器部署和高级用户。下载后需手动添加到系统 PATH 环境变量。

发布页

也可以在 Releases 页面 下载最新版本，并将可执行文件添加到系统的 PATH 环境变量中。

使用Docker 部署

快速开始

# 拉取并运行最新镜像
docker run -d \
  --name comigo \
  -p 1234:1234 \
  -v /path/to/your/books:/data \
  yumenaka/comigo:latest

访问 http://localhost:1234 即可使用。

使用 Docker Compose

1. 下载 docker-compose.yml 文件
2. 根据需要编辑配置
3. 启动服务：

docker-compose up -d

更多详细说明请查看完整的 Docker 使用文档。

使用方法

comi [flags] file_or_dir

命令行参数

使用示例

# 打开当前目录
comi .

# 指定端口和书库路径
comi -p 8080 /path/to/manga

# 仅本地访问，启用登录保护
comi --local --username admin --password 123456 /path/to/manga

# 使用配置文件
comi -c /path/to/comigo.toml

配置文件说明

Comigo 支持多种配置文件位置：

1. 用户主目录

   • Windows: C:\Users\用户名\.config\comigo.toml
   • Linux/MacOS: /home/用户名/.config/comigo.toml
   • 程序启动时默认读取此位置

2. 程序目录

   • 将 comigo.toml 放在可执行文件同目录
   • 适合作为绿色软件使用

3. 当前运行目录

   • 在启动命令的当前目录下查找配置文件

4. 自定义位置

   • 使用 --config 参数指定配置文件路径

配置文件示例

# comigo.toml 配置示例

# 服务设置
Port = 1234                    # 服务端口
Host = ""                      # 自定义主机名（留空自动检测）
DisableLAN = false             # 仅本地访问
OpenBrowser = false            # 启动后打开浏览器
Language = "auto"              # 界面语言 (auto/zh/en/ja)

# 书库设置
StoreUrls = ["/path/to/manga", "/path/to/comics"]  # 书库路径列表
MaxScanDepth = 5               # 扫描深度
MinImageNum = 1                # 最少图片数量
AutoRescanIntervalMinutes = 0  # 自动扫描间隔（0为禁用）

# 登录保护
Username = ""                  # 用户名（留空禁用登录）
Password = ""                  # 密码
Timeout = 43200                # Cookie过期时间（分钟）

# 功能开关
EnableUpload = true            # 启用上传
ReadOnlyMode = false           # 只读模式
EnablePlugin = true            # 启用插件
Debug = false                  # 调试模式

# 缓存设置
UseCache = false               # 启用图片缓存
CacheDir = ""                  # 缓存目录（留空使用系统临时目录）
ClearCacheExit = false         # 退出时清除缓存

# ZIP文件设置
ZipFileTextEncoding = "gbk"    # 非UTF-8编码ZIP的解析编码

反馈与支持

如果您有任何建议或遇到问题，欢迎：

• 提交 Issue
• 通过 Twitter 联系我
• Discord讨论群 Discord

开发与TODO

• 开发备忘

特别鸣谢

感谢以下开源项目及其贡献者：

• mholt
• spf13
• disintegration
• Baozisoftware
• 以及更多贡献者

项目统计

开源协议

本项目采用 MIT 协议开源。