Skip to content

Jinbocho Manuals

Complete documentation for Jinbocho: Home Library Management System.

What You'll Find Here

This directory contains two comprehensive manuals:

👨‍💻 Self-Hosting Guide

For anyone self-hosting Jinbocho on their own server: - Install Jinbocho on a VPS, home server, or NAS - Verify the deployment is healthy - Troubleshoot common issues

Key sections: - Prerequisites (Docker, Git) - Production deployment guide (quick start + manual) - Monitoring, logging, troubleshooting

Time to read: ~30 minutes to get a running stack

👥 User Manual

For end-users and family members who want to: - Create an account and get started - Add and organize books - Search and filter your library - Invite family members - Track reading progress

Key sections: - Getting started and account creation - Authentication and account management - Adding and managing books - Organizing locations (rooms, bookcases, shelves) - Advanced features (scanning, export, bulk operations) - Family management and user roles - Mobile tips and localization

Time to read: ~1-2 hours to learn all features

Quick Start

For Self-Hosters

  1. Start here: Self-Hosting Guide → Prerequisites
  2. Then: Production Deployment
  3. One command gets you a running stack

For Users

  1. Start here: User Manual → Getting Started
  2. Then: Authentication & Accounts
  3. Follow the in-app guides for your first actions

Browse by Topic

Self-Hosting - System requirements: Prerequisites - Install: Production Deployment

Getting Started (Users) - Create your account: Getting Started - Understand login & security: Authentication

Using Jinbocho (Users) - Add books: Core Features (coming soon) - Organize rooms/bookcases: Core Features (coming soon) - Search and filter: Core Features (coming soon)

Deploying to Production - Self-hosted setup: Production Deployment - Monitoring: Monitoring & Logging

Contributing

If you find: - ❌ Outdated information - 🤔 Unclear instructions - 🐛 Broken links - ✨ Missing documentation

Please:

  • Report on GitHub Issues
  • Email support@jinbocho.eu
  • Submit a PR with fixes

Resources

  • Docker: https://docker.com