Skip to content

Home EN

Jump to bottom
github-actions[bot] edited this page Sep 15, 2026 · 38 revisions

GalleryVault Documentation Hub

中文 · English

Welcome to the official GalleryVault documentation. It is a self-hosted gallery library for Ehviewer export folders: files, the index, and favorite mappings stay on your machine or NAS. It scans <gid>-title/ trees and SpiderInfo as-is. Cookies are recommended for E-Hentai / ExHentai sync; without them it still works as a local library. See Features.

What it does

  • Mount Ehviewer <gid>-title/ trees, CBZ, 7z (images only), and PDF as-is (SpiderInfo / sidecars). No unpack-and-rename step.
  • With cookies: Discover, ten favorite folders, page or official Archive downloads, GID replacements.
  • Manage: same-GID copies, favorite dupes, cross-GID, missing/corrupt pages, optional multi-disk cold CBZ.
  • Reader: RTL / dual-page / webtoon; slideshow follows GIF/WebP frame duration. Optional OPDS, at-rest field encryption, and a Telegram bot (paste URLs to enqueue, queue actions, scan / quota / local search with covers).

Downloads go to downloads/. Cold archive uses archive_roots you configure (./archive is not mounted by default). See Features.

Get started

A. Existing Ehviewer folders

  1. Mount the host folder into the backend (e.g. /data/Ehviewer:/Ehviewer:ro).
  2. Settings → Library: add the container path to library roots, save.
  3. Open Library (#/library) and click Scan library.
  4. Compatibility · Library

B. Favorite folders

  1. Settings → Site & proxy: paste cookies, Test login.
  2. Favorites (#/favorites): enable folders; incremental download or watch-only.
  3. Favorites · Downloads

C. Dedupe and GID replacements

  1. Manage → Favorite duplicates (#/duplicates/favorites).
  2. Manage → Cross-GID (#/duplicates/cross-gid).
  3. From Favorites open Updates (#/updates).
  4. Manage · Updates

D. Cold archive

  1. Mount archive volumes; set archive_roots under Settings → Library.
  2. Manage → Cold archive (#/archive) → Start archive; later purge archived sources (same button on the Settings storage table).
  3. Deployment · Cold archive

E. Series and integrity

  1. Top nav Series (#/series).
  2. Manage → Integrity (#/integrity): scan, then repair.
  3. Series · Integrity

Documentation Navigation

📖 User Guides

  • Features — Comprehensive feature matrix, design philosophy, and system architecture
  • Usage Guide — Searching, reader navigation, download queue, favorites monitoring, deduplication, and recycle bin
  • Screenshots — Interface previews across major modules in English and Chinese
  • FAQ — Troubleshooting guides, network tuning, cookie maintenance, and common questions

⚙️ Operations & Deployment

  • Compatibility — Directory hierarchies, SpiderInfo V1/V2 formats, Sidecar JSON schemas, and client matrix
  • Deployment — Docker Compose quickstart, volume mounts, Nginx/Caddy reverse proxies, and permission setup
  • Backup & Restore — Database snapshots, cold archive exports, and disaster recovery procedures
  • Encryption at Rest — AES-256-GCM database encryption mechanism, key management, and emergency recovery

API and development notes live in the repo: backend/docs/API.md and backend/docs/DEVELOPMENT.md (not on the GitHub Wiki).

Quick Launch

mkdir galleryvault && cd galleryvault
curl -fsSL https://raw.githubusercontent.com/ResidualBlood/galleryvault/main/docker-compose.yml -o docker-compose.yml
docker compose up -d
  • Web Access: http://<host-ip>:8000
  • Default Password: p1a2s3s4 (login opens #/welcome; you must change it)
  • Persistent Data: Stored locally in ./library, ./downloads, ./db-data, and ./cache.

License

Released under the open-source MIT License.

📖 GalleryVault

开始

使用

运维

Clone this wiki locally