# grimmory-self-hosted-library

Helps AI agents configure and run the self-hosted Grimmory book manager in Docker, set up e-reader sync, and extend its Spring Boot backend.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1300 installs · ★ 88
- Author: reason-machines
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/reason-machines/trending-skills/tree/HEAD/skills/grimmory-self-hosted-library/SKILL.md
- Updated: 2026-10-09
- HTML: https://affpapa.org/en/nevibecode/skills/grimmory-self-hosted-library

## What it does

This skill equips your coding agent with setup recipes for Grimmory, a personal library server replacing BookLore. It covers building the `docker-compose.yml` file alongside MariaDB, mapping persistent storage volumes, and configuring environment parameters.

The guide details auto-import routines via the BookDrop folder, metadata fetching from public registries, and syncing with Kobo and KOReader hardware. Setting `DISK_TYPE=NETWORK` prevents accidental file deletion or renaming whenever books sit on shared SMB or NFS volumes.

For backend development, the instructions document the `/api/v1/` REST interface and common Spring Boot patterns. You will need Docker and Docker Compose installed locally, because the instructions rely strictly on container execution.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add reason-machines/trending-skills --skill grimmory-self-hosted-library -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/grimmory-self-hosted-library/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/grimmory-self-hosted-library/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add reason-machines/trending-skills --skill grimmory-self-hosted-library -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/grimmory-self-hosted-library/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add reason-machines/trending-skills --skill grimmory-self-hosted-library -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/grimmory-self-hosted-library/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install reason-machines/trending-skills grimmory-self-hosted-library
```

2. **Manually: put the files in place**
- File: `.github/skills/grimmory-self-hosted-library/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add reason-machines/trending-skills --skill grimmory-self-hosted-library -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/reason-machines/trending-skills --path skills/grimmory-self-hosted-library
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/grimmory-self-hosted-library/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add reason-machines/trending-skills --skill grimmory-self-hosted-library -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/reason-machines/trending-skills/tree/HEAD/skills/grimmory-self-hosted-library/SKILL.md

## When to use it
- deploy Grimmory and MariaDB containers via Docker Compose
- configure the BookDrop folder for automatic ebook ingest
- link KOReader and Kobo devices through OPDS and sync endpoints
- protect SMB or NFS storage against deletions via `DISK_TYPE=NETWORK`
- build custom Java endpoints against the Grimmory REST API

## Example prompts
- Generate a docker-compose.yml and .env setup for Grimmory with MariaDB
- How do I configure BookDrop auto-import and OPDS in Grimmory?
- Write a Spring Boot controller for the Grimmory API to manage shelves

## Similar
- [wizard](https://affpapa.org/en/nevibecode/skills/wizard.md) — skill · 553369 installs
- [hyperframes-cli](https://affpapa.org/en/nevibecode/skills/heygen-com-hyperframes-cli.md) — skill · 1300000 installs
- [setup-pre-commit](https://affpapa.org/en/nevibecode/skills/setup-pre-commit.md) — skill · 489289 installs
- [using-git-worktrees](https://affpapa.org/en/nevibecode/skills/using-git-worktrees.md) — skill · 217153 installs
- [finishing-a-development-branch](https://affpapa.org/en/nevibecode/skills/finishing-a-development-branch.md) — skill · 214439 installs
- [orca-cli](https://affpapa.org/en/nevibecode/skills/orca-cli.md) — skill · 353600 installs

From the same set: [reason-machines/trending-skills](https://affpapa.org/en/nevibecode/by/reason-machines/trending-skills.md) — 139 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md