grimmory-self-hosted-library
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseGrimmory Self-Hosted Library Manager
Grimmory 自托管书籍库管理器
Skill by ara.so — Daily 2026 Skills collection.
Grimmory is a self-hosted application (successor to BookLore) for managing your entire book collection. It supports EPUBs, PDFs, MOBIs, AZW/AZW3, and comics (CBZ/CBR/CB7), with a built-in browser reader, annotations, Kobo/OPDS sync, KOReader progress sync, metadata enrichment, and multi-user support.
由ara.so提供的Skill —— 2026每日技能合集。
Grimmory是一款自托管应用(BookLore的继任者),用于管理您的全部书籍收藏。它支持EPUB、PDF、MOBI、AZW/AZW3以及漫画格式(CBZ/CBR/CB7),内置浏览器阅读器、注释功能、Kobo/OPDS同步、KOReader进度同步、元数据补全以及多用户支持。
Installation
安装
Requirements
要求
- Docker and Docker Compose
- Docker 和 Docker Compose
Step 1: Create .env
.env步骤1:创建.env
文件
.envini
undefinedini
undefinedApplication
Application
APP_USER_ID=1000
APP_GROUP_ID=1000
TZ=Etc/UTC
APP_USER_ID=1000
APP_GROUP_ID=1000
TZ=Etc/UTC
Database
Database
DATABASE_URL=jdbc:mariadb://mariadb:3306/grimmory
DB_USER=grimmory
DB_PASSWORD=${DB_PASSWORD}
DATABASE_URL=jdbc:mariadb://mariadb:3306/grimmory
DB_USER=grimmory
DB_PASSWORD=${DB_PASSWORD}
Storage: LOCAL (default) or NETWORK
Storage: LOCAL (default) or NETWORK
DISK_TYPE=LOCAL
DISK_TYPE=LOCAL
MariaDB
MariaDB
DB_USER_ID=1000
DB_GROUP_ID=1000
MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
MYSQL_DATABASE=grimmory
undefinedDB_USER_ID=1000
DB_GROUP_ID=1000
MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
MYSQL_DATABASE=grimmory
undefinedStep 2: Create docker-compose.yml
docker-compose.yml步骤2:创建docker-compose.yml
文件
docker-compose.ymlyaml
services:
grimmory:
image: grimmory/grimmory:latest
# Alternative registry: ghcr.io/grimmory-tools/grimmory:latest
container_name: grimmory
environment:
- USER_ID=${APP_USER_ID}
- GROUP_ID=${APP_GROUP_ID}
- TZ=${TZ}
- DATABASE_URL=${DATABASE_URL}
- DATABASE_USERNAME=${DB_USER}
- DATABASE_PASSWORD=${DB_PASSWORD}
- DISK_TYPE=${DISK_TYPE}
depends_on:
mariadb:
condition: service_healthy
ports:
- "6060:6060"
volumes:
- ./data:/app/data
- ./books:/books
- ./bookdrop:/bookdrop
healthcheck:
test: wget -q -O - http://localhost:6060/api/v1/healthcheck
interval: 60s
retries: 5
start_period: 60s
timeout: 10s
restart: unless-stopped
mariadb:
image: lscr.io/linuxserver/mariadb:11.4.5
container_name: mariadb
environment:
- PUID=${DB_USER_ID}
- PGID=${DB_GROUP_ID}
- TZ=${TZ}
- MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
- MYSQL_DATABASE=${MYSQL_DATABASE}
- MYSQL_USER=${DB_USER}
- MYSQL_PASSWORD=${DB_PASSWORD}
volumes:
- ./mariadb/config:/config
restart: unless-stopped
healthcheck:
test: ["CMD", "mariadb-admin", "ping", "-h", "localhost"]
interval: 5s
timeout: 5s
retries: 10yaml
services:
grimmory:
image: grimmory/grimmory:latest
# Alternative registry: ghcr.io/grimmory-tools/grimmory:latest
container_name: grimmory
environment:
- USER_ID=${APP_USER_ID}
- GROUP_ID=${APP_GROUP_ID}
- TZ=${TZ}
- DATABASE_URL=${DATABASE_URL}
- DATABASE_USERNAME=${DB_USER}
- DATABASE_PASSWORD=${DB_PASSWORD}
- DISK_TYPE=${DISK_TYPE}
depends_on:
mariadb:
condition: service_healthy
ports:
- "6060:6060"
volumes:
- ./data:/app/data
- ./books:/books
- ./bookdrop:/bookdrop
healthcheck:
test: wget -q -O - http://localhost:6060/api/v1/healthcheck
interval: 60s
retries: 5
start_period: 60s
timeout: 10s
restart: unless-stopped
mariadb:
image: lscr.io/linuxserver/mariadb:11.4.5
container_name: mariadb
environment:
- PUID=${DB_USER_ID}
- PGID=${DB_GROUP_ID}
- TZ=${TZ}
- MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
- MYSQL_DATABASE=${MYSQL_DATABASE}
- MYSQL_USER=${DB_USER}
- MYSQL_PASSWORD=${DB_PASSWORD}
volumes:
- ./mariadb/config:/config
restart: unless-stopped
healthcheck:
test: ["CMD", "mariadb-admin", "ping", "-h", "localhost"]
interval: 5s
timeout: 5s
retries: 10Step 3: Launch
步骤3:启动服务
bash
docker compose up -dbash
docker compose up -dView logs
查看日志
docker compose logs -f grimmory
docker compose logs -f grimmory
Check health
检查健康状态
Open http://localhost:6060 and create your admin account.
---
打开 http://localhost:6060 并创建您的管理员账户。
---Volume Layout
卷目录结构
./data/ # App data, thumbnails, user config
./books/ # Your book files (mounted at /books)
./bookdrop/ # Drop-zone for auto-import (mounted at /bookdrop)
./mariadb/ # MariaDB data./data/ # 应用数据、缩略图、用户配置
./books/ # 您的书籍文件(挂载到容器内的/books)
./bookdrop/ # 自动导入的拖放区域(挂载到容器内的/bookdrop)
./mariadb/ # MariaDB 数据Environment Variables Reference
环境变量参考
| Variable | Description | Default |
|---|---|---|
| UID for the app process | |
| GID for the app process | |
| Timezone string | |
| JDBC connection string | required |
| DB username | required |
| DB password | required |
| | |
| 变量 | 说明 | 默认值 |
|---|---|---|
| 应用进程的UID | |
| 应用进程的GID | |
| 时区字符串 | |
| JDBC连接字符串 | 必填 |
| 数据库用户名 | 必填 |
| 数据库密码 | 必填 |
| | |
Supported Book Formats
支持的书籍格式
| Category | Formats |
|---|---|
| eBooks | EPUB, MOBI, AZW, AZW3 |
| Documents | |
| Comics | CBZ, CBR, CB7 |
| 分类 | 格式 |
|---|---|
| 电子书 | EPUB, MOBI, AZW, AZW3 |
| 文档 | |
| 漫画 | CBZ, CBR, CB7 |
BookDrop (Auto-Import)
BookDrop(自动导入)
Drop files into on your host. Grimmory watches the folder, extracts metadata from Google Books and Open Library, and queues books for review.
./bookdrop/./bookdrop/
my-novel.epub ← dropped here
another-book.pdf ← dropped hereFlow:
- Watch — Grimmory monitors continuously
/bookdrop - Detect — New files are picked up and parsed
- Enrich — Metadata fetched from Google Books / Open Library
- Import — Review in UI, adjust if needed, confirm import
Volume mapping required in :
docker-compose.ymlyaml
volumes:
- ./bookdrop:/bookdrop将文件放入主机的目录中。Grimmory会监控该文件夹,从Google Books和Open Library提取元数据,并将书籍加入审核队列。
./bookdrop/./bookdrop/
my-novel.epub ← 拖放到此处
another-book.pdf ← 拖放到此处流程:
- 监控 —— Grimmory持续监控目录
/bookdrop - 检测 —— 识别并解析新文件
- 补全 —— 从Google Books / Open Library获取元数据
- 导入 —— 在UI中审核,按需调整后确认导入
docker-compose.ymlyaml
volumes:
- ./bookdrop:/bookdropNetwork Storage Mode
网络存储模式
For NFS, SMB, or other network-mounted filesystems, set . This disables destructive UI operations (delete, move, rename) to protect shared mounts while keeping reading, metadata, and sync fully functional.
DISK_TYPE=NETWORKini
undefined对于NFS、SMB或其他网络挂载的文件系统,设置。这会禁用UI中的破坏性操作(删除、移动、重命名)以保护共享挂载,同时保持阅读、元数据管理和同步功能完全可用。
DISK_TYPE=NETWORKini
undefined.env
.env
DISK_TYPE=NETWORK
---DISK_TYPE=NETWORK
---Java Backend — Key Patterns
Java后端——核心模式
Grimmory is a Java application (Spring Boot + MariaDB). When contributing or extending:
Grimmory是一款Java应用(Spring Boot + MariaDB)。在贡献代码或进行扩展时:
Project Structure (typical Spring Boot layout)
项目结构(典型Spring Boot布局)
src/main/java/
com/grimmory/
config/ # Spring configuration classes
controller/ # REST API controllers
service/ # Business logic
repository/ # JPA repositories
model/ # JPA entities
dto/ # Data transfer objectssrc/main/java/
com/grimmory/
config/ # Spring配置类
controller/ # REST API控制器
service/ # 业务逻辑
repository/ # JPA仓库
model/ # JPA实体类
dto/ # 数据传输对象REST API — Base Path
REST API——基础路径
All endpoints are under :
/api/v1/bash
undefined所有端点都在路径下:
/api/v1/bash
undefinedHealth check
健康检查
Books
书籍相关
Shelves
书架相关
OPDS catalog (for compatible reader apps)
OPDS目录(用于兼容的阅读器应用)
undefinedundefinedExample: Querying the API with Java (OkHttp)
示例:使用Java(OkHttp)调用API
java
import okhttp3.*;
import com.fasterxml.jackson.databind.ObjectMapper;
public class GrimmoryClient {
private final OkHttpClient http = new OkHttpClient();
private final ObjectMapper mapper = new ObjectMapper();
private final String baseUrl;
private final String token;
public GrimmoryClient(String baseUrl, String token) {
this.baseUrl = baseUrl;
this.token = token;
}
public String getBooks() throws Exception {
Request request = new Request.Builder()
.url(baseUrl + "/api/v1/books")
.header("Authorization", "Bearer " + token)
.build();
try (Response response = http.newCall(request).execute()) {
return response.body().string();
}
}
}java
import okhttp3.*;
import com.fasterxml.jackson.databind.ObjectMapper;
public class GrimmoryClient {
private final OkHttpClient http = new OkHttpClient();
private final ObjectMapper mapper = new ObjectMapper();
private final String baseUrl;
private final String token;
public GrimmoryClient(String baseUrl, String token) {
this.baseUrl = baseUrl;
this.token = token;
}
public String getBooks() throws Exception {
Request request = new Request.Builder()
.url(baseUrl + "/api/v1/books")
.header("Authorization", "Bearer " + token)
.build();
try (Response response = http.newCall(request).execute()) {
return response.body().string();
}
}
}Example: Spring Boot Controller Pattern
示例:Spring Boot控制器模式
java
@RestController
@RequestMapping("/api/v1/books")
@RequiredArgsConstructor
public class BookController {
private final BookService bookService;
@GetMapping
public ResponseEntity<Page<BookDto>> getAllBooks(
@RequestParam(defaultValue = "0") int page,
@RequestParam(defaultValue = "20") int size,
@RequestParam(required = false) String search) {
return ResponseEntity.ok(bookService.findAll(page, size, search));
}
@GetMapping("/{id}")
public ResponseEntity<BookDto> getBook(@PathVariable Long id) {
return ResponseEntity.ok(bookService.findById(id));
}
@PostMapping
public ResponseEntity<BookDto> createBook(@RequestBody @Valid CreateBookRequest request) {
return ResponseEntity.status(HttpStatus.CREATED)
.body(bookService.create(request));
}
@PutMapping("/{id}/metadata")
public ResponseEntity<BookDto> updateMetadata(
@PathVariable Long id,
@RequestBody @Valid UpdateMetadataRequest request) {
return ResponseEntity.ok(bookService.updateMetadata(id, request));
}
}java
@RestController
@RequestMapping("/api/v1/books")
@RequiredArgsConstructor
public class BookController {
private final BookService bookService;
@GetMapping
public ResponseEntity<Page<BookDto>> getAllBooks(
@RequestParam(defaultValue = "0") int page,
@RequestParam(defaultValue = "20") int size,
@RequestParam(required = false) String search) {
return ResponseEntity.ok(bookService.findAll(page, size, search));
}
@GetMapping("/{id}")
public ResponseEntity<BookDto> getBook(@PathVariable Long id) {
return ResponseEntity.ok(bookService.findById(id));
}
@PostMapping
public ResponseEntity<BookDto> createBook(@RequestBody @Valid CreateBookRequest request) {
return ResponseEntity.status(HttpStatus.CREATED)
.body(bookService.create(request));
}
@PutMapping("/{id}/metadata")
public ResponseEntity<BookDto> updateMetadata(
@PathVariable Long id,
@RequestBody @Valid UpdateMetadataRequest request) {
return ResponseEntity.ok(bookService.updateMetadata(id, request));
}
}Example: JPA Entity Pattern
示例:JPA实体类模式
java
@Entity
@Table(name = "books")
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Book {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(nullable = false)
private String title;
private String author;
private String isbn;
private String format; // EPUB, PDF, CBZ, etc.
@Column(name = "file_path")
private String filePath;
@Column(name = "cover_path")
private String coverPath;
@Column(name = "reading_progress")
private Double readingProgress;
@ManyToMany
@JoinTable(
name = "book_shelf",
joinColumns = @JoinColumn(name = "book_id"),
inverseJoinColumns = @JoinColumn(name = "shelf_id")
)
private Set<Shelf> shelves = new HashSet<>();
@CreationTimestamp
private LocalDateTime createdAt;
@UpdateTimestamp
private LocalDateTime updatedAt;
}java
@Entity
@Table(name = "books")
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Book {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(nullable = false)
private String title;
private String author;
private String isbn;
private String format; // EPUB, PDF, CBZ, etc.
@Column(name = "file_path")
private String filePath;
@Column(name = "cover_path")
private String coverPath;
@Column(name = "reading_progress")
private Double readingProgress;
@ManyToMany
@JoinTable(
name = "book_shelf",
joinColumns = @JoinColumn(name = "book_id"),
inverseJoinColumns = @JoinColumn(name = "shelf_id")
)
private Set<Shelf> shelves = new HashSet<>();
@CreationTimestamp
private LocalDateTime createdAt;
@UpdateTimestamp
private LocalDateTime updatedAt;
}Example: Service with Metadata Enrichment
示例:元数据补全服务
java
@Service
@RequiredArgsConstructor
public class MetadataService {
private final GoogleBooksClient googleBooksClient;
private final OpenLibraryClient openLibraryClient;
private final BookRepository bookRepository;
public BookDto enrichMetadata(Long bookId) {
Book book = bookRepository.findById(bookId)
.orElseThrow(() -> new BookNotFoundException(bookId));
// Try Google Books first
Optional<BookMetadata> metadata = googleBooksClient.search(book.getTitle(), book.getAuthor());
// Fall back to Open Library
if (metadata.isEmpty()) {
metadata = openLibraryClient.search(book.getIsbn());
}
metadata.ifPresent(m -> {
book.setDescription(m.getDescription());
book.setCoverUrl(m.getCoverUrl());
book.setPublisher(m.getPublisher());
book.setPublishedDate(m.getPublishedDate());
bookRepository.save(book);
});
return BookDto.from(book);
}
}java
@Service
@RequiredArgsConstructor
public class MetadataService {
private final GoogleBooksClient googleBooksClient;
private final OpenLibraryClient openLibraryClient;
private final BookRepository bookRepository;
public BookDto enrichMetadata(Long bookId) {
Book book = bookRepository.findById(bookId)
.orElseThrow(() -> new BookNotFoundException(bookId));
// 优先尝试Google Books
Optional<BookMetadata> metadata = googleBooksClient.search(book.getTitle(), book.getAuthor());
// 如果失败,回退到Open Library
if (metadata.isEmpty()) {
metadata = openLibraryClient.search(book.getIsbn());
}
metadata.ifPresent(m -> {
book.setDescription(m.getDescription());
book.setCoverUrl(m.getCoverUrl());
book.setPublisher(m.getPublisher());
book.setPublishedDate(m.getPublishedDate());
bookRepository.save(book);
});
return BookDto.from(book);
}
}OPDS Integration
OPDS集成
Connect any OPDS-compatible reader app (Kybook, Chunky, Moon+ Reader, etc.) using:
http://<your-host>:6060/opdsAuthenticate with your Grimmory username and password when prompted.
使用以下地址连接任何支持OPDS的阅读器应用(Kybook、Chunky、Moon+ Reader等):
http://<你的主机地址>:6060/opds出现提示时,使用您的Grimmory用户名和密码进行认证。
Kobo / KOReader Sync
Kobo / KOReader同步
- Kobo: Connect via the device sync feature in Grimmory settings. The app exposes a sync endpoint compatible with Kobo's API.
- KOReader: Configure KOReader's sync plugin to point to your Grimmory instance URL.
- Kobo:通过Grimmory设置中的设备同步功能连接。应用会暴露一个与Kobo API兼容的同步端点。
- KOReader:配置KOReader的同步插件,指向您的Grimmory实例地址。
Multi-User & Authentication
多用户与认证
Local Authentication
本地认证
Create users from the admin panel at http://localhost:6060. Each user has isolated shelves, reading progress, and preferences.
在 http://localhost:6060 的管理员面板中创建用户。每个用户都有独立的书架、阅读进度和偏好设置。
OIDC Authentication
OIDC认证
Configure via environment variables (refer to full documentation at https://grimmory.org/docs/getting-started for OIDC-specific variables such as , , ).
OIDC_ISSUER_URIOIDC_CLIENT_IDOIDC_CLIENT_SECRET通过环境变量进行配置(有关OIDC特定变量如、、的详细信息,请参考官方文档 https://grimmory.org/docs/getting-started)。
OIDC_ISSUER_URIOIDC_CLIENT_IDOIDC_CLIENT_SECRETBuilding from Source
从源码构建
bash
undefinedbash
undefinedClone the repository
克隆仓库
git clone https://github.com/grimmory-tools/grimmory.git
cd grimmory
git clone https://github.com/grimmory-tools/grimmory.git
cd grimmory
Build with Maven
使用Maven构建
./mvnw clean package -DskipTests
./mvnw clean package -DskipTests
Or build Docker image locally
或本地构建Docker镜像
docker build -t grimmory:local .
docker build -t grimmory:local .
Use local build in docker-compose.yml
在docker-compose.yml中使用本地构建的镜像
Comment out 'image' and uncomment 'build: .'
注释掉'image'行,取消注释'build: .'行
---
---Common Docker Commands
常用Docker命令
bash
undefinedbash
undefinedStart services
启动服务
docker compose up -d
docker compose up -d
Stop services
停止服务
docker compose down
docker compose down
View app logs
查看应用日志
docker compose logs -f grimmory
docker compose logs -f grimmory
View DB logs
查看数据库日志
docker compose logs -f mariadb
docker compose logs -f mariadb
Restart only the app
仅重启应用
docker compose restart grimmory
docker compose restart grimmory
Pull latest image and redeploy
拉取最新镜像并重新部署
docker compose pull && docker compose up -d
docker compose pull && docker compose up -d
Open a shell inside the container
进入容器的shell环境
docker exec -it grimmory /bin/bash
docker exec -it grimmory /bin/bash
Database shell
进入数据库shell
docker exec -it mariadb mariadb -u grimmory -p grimmory
---docker exec -it mariadb mariadb -u grimmory -p grimmory
---Troubleshooting
故障排除
Container won't start — DB connection refused
容器无法启动——数据库连接被拒绝
bash
undefinedbash
undefinedCheck MariaDB health
检查MariaDB健康状态
docker compose ps mariadb
docker compose ps mariadb
Should show "healthy". If not:
状态应为"healthy"。如果不是:
docker compose logs mariadb
docker compose logs mariadb
Ensure DATABASE_URL host matches the service name: mariadb:3306
确保DATABASE_URL中的主机名与服务名匹配:mariadb:3306
undefinedundefinedBooks not appearing after BookDrop
拖放到BookDrop后书籍未显示
bash
undefinedbash
undefinedVerify file permissions — UID/GID must match APP_USER_ID/APP_GROUP_ID
验证文件权限——UID/GID必须与APP_USER_ID/APP_GROUP_ID匹配
ls -la ./bookdrop/
ls -la ./bookdrop/
Check app logs for detection events
查看应用日志中的检测事件
docker compose logs -f grimmory | grep -i bookdrop
undefineddocker compose logs -f grimmory | grep -i bookdrop
undefinedPermission denied on ./books or ./data
访问./books或./data时权限被拒绝
bash
undefinedbash
undefinedSet ownership to match APP_USER_ID / APP_GROUP_ID
设置文件所有权以匹配APP_USER_ID / APP_GROUP_ID
sudo chown -R 1000:1000 ./books ./data ./bookdrop
undefinedsudo chown -R 1000:1000 ./books ./data ./bookdrop
undefinedOPDS not accessible from reader app
阅读器应用无法访问OPDS
bash
undefinedbash
undefinedConfirm port 6060 is reachable from your device
确认您的设备可以访问6060端口
curl http://<host-ip>:6060/api/v1/healthcheck
curl http://<主机IP>:6060/api/v1/healthcheck
Check firewall rules if on a remote server
如果是远程服务器,请检查防火墙规则
undefinedundefinedHigh memory usage
内存占用过高
MariaDB and Grimmory together require at minimum ~512 MB RAM. For large libraries (10k+ books), allocate 1–2 GB.
MariaDB和Grimmory总共至少需要约512 MB内存。对于大型书籍库(1万本以上),建议分配1–2 GB内存。
Metadata not enriching
元数据无法补全
Google Books and Open Library require outbound internet access from the container. Verify DNS and network:
bash
docker exec -it grimmory curl -s "https://www.googleapis.com/books/v1/volumes?q=test"Google Books和Open Library要求容器能够访问外网。验证DNS和网络连接:
bash
docker exec -it grimmory curl -s "https://www.googleapis.com/books/v1/volumes?q=test"Contributing
贡献指南
Before opening a pull request:
- Open an issue and get maintainer approval
- Include screenshots/video proof and pasted test output
- Follow backend and frontend conventions in
CONTRIBUTING.md - AI-assisted code is allowed but you must run, test, and understand every line
bash
undefined提交拉取请求前:
- 提交issue并获得维护者的批准
- 提供截图/视频证明以及测试输出
- 遵循中的后端和前端规范
CONTRIBUTING.md - 允许使用AI辅助生成代码,但您必须运行、测试并理解每一行代码
bash
undefinedRun tests before submitting
提交前运行测试
./mvnw test
./mvnw test
Check code style
检查代码风格
./mvnw checkstyle:check
---./mvnw checkstyle:check
---Links
相关链接
- GitHub: https://github.com/grimmory-tools/grimmory
- Docker Hub: https://hub.docker.com/r/grimmory/grimmory
- GHCR:
ghcr.io/grimmory-tools/grimmory - Discord: https://discord.gg/FwqHeFWk
- Docs: https://grimmory.org/docs/getting-started
- License: AGPL-3.0
- GitHub: https://github.com/grimmory-tools/grimmory
- Docker Hub: https://hub.docker.com/r/grimmory/grimmory
- GHCR:
ghcr.io/grimmory-tools/grimmory - Discord: https://discord.gg/FwqHeFWk
- 文档: https://grimmory.org/docs/getting-started
- 许可证: AGPL-3.0