mirror of
https://github.com/bookorbit/bookorbit.git
synced 2026-11-03 00:11:37 -06:00
neon
124 lines
7.2 KiB
Markdown
124 lines
7.2 KiB
Markdown
<div align="center">
|
|
|
|
# BookOrbit
|
|
|
|
A self-hosted library management and reading platform for ebooks, PDFs, audiobooks, and comics.
|
|
|
|
[](https://github.com/bookorbit/bookorbit/releases)
|
|
[](https://github.com/bookorbit/bookorbit/stargazers)
|
|
[](https://github.com/bookorbit/bookorbit/actions/workflows/ci.yml)
|
|
[](https://github.com/bookorbit/bookorbit/actions/workflows/release.yml)
|
|
[](https://codecov.io/gh/bookorbit/bookorbit)
|
|
|
|
[](https://bookorbit.app)
|
|
[](https://demo.bookorbit.app/magic?token=2d92cb900e184cf0eb8b11f72cffc6011673d1016e1b300d750eb3d76abc1572)
|
|
[](https://github.com/bookorbit/bookorbit/pkgs/container/bookorbit)
|
|
[](https://github.com/bookorbit/bookorbit/discussions)
|
|
[](https://github.com/bookorbit/bookorbit/blob/main/docs/CONTRIBUTING.md)
|
|
[](LICENSE)
|
|
|
|
<!--
|
|
[](https://github.com/bookorbit/bookorbit/pkgs/container/bookorbit)
|
|
[Website](https://bookorbit.app) · [Demo](https://demo.bookorbit.app) · [Discussions](https://github.com/bookorbit/bookorbit/discussions) · [Contributing](https://github.com/bookorbit/bookorbit/blob/main/docs/CONTRIBUTING.md) · [Changelog](https://github.com/bookorbit/bookorbit/releases)
|
|
-->
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
|
|
|
|
## What is BookOrbit?
|
|
|
|
**[BookOrbit](https://bookorbit.app)** is a self-hosted digital library and reading platform. Organize and read your books, sync seamlessly with Kobo and KOReader devices, enrich your collection with metadata from multiple providers, and support multiple users with OIDC/SSO authentication and detailed reading statistics. Built-in features include OPDS support, customizable dashboard widgets, Send-to-Kindle delivery, and Smart Scopes for dynamic rule-based shelves and filters - all running on infrastructure you control.
|
|
|
|
[](https://bookorbit.app)
|
|
|
|
---
|
|
|
|
## Live Demo
|
|
|
|
Want to try BookOrbit before installing? Explore the live instance instantly: no account required!
|
|
|
|
[](https://demo.bookorbit.app/magic?token=2d92cb900e184cf0eb8b11f72cffc6011673d1016e1b300d750eb3d76abc1572)
|
|
|
|
_Experience the interface, built-in readers, and dashboard first-hand._
|
|
|
|
> **Note:** The demo includes a sample library of public domain books. Some administrative features are limited in the public demo. Self-hosting BookOrbit provides the full experience.
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
### Reading Experience & Sync
|
|
|
|
- **Built-in Web Readers**: Native support for eBooks (EPUB, MOBI, AZW3), PDFs, Comics (CBZ, CBR), and Audiobooks (M4B, MP3) with no extra plugins required.
|
|
- **Kobo & KOReader Integration**: Automatically push books to your Kobo devices and maintain two-way reading progress sync via KOReader over OPDS.
|
|
- **Reading Statistics**: Track your daily reading time, view heatmaps, maintain streaks, and monitor library health.
|
|
|
|
### Library Management
|
|
|
|
- **Multiple Libraries**: Isolate content with per-library folders, custom scan rules, and format priorities.
|
|
- **Rich Metadata Providers**: Fetch robust metadata from Google Books, Amazon, Goodreads, Hardcover, Open Library, Audible, ComicVine, and more.
|
|
- **Smart Scopes & Collections**: Organize your collection using curated lists and dynamic, rule-based saved filters.
|
|
|
|
### Platform & Delivery
|
|
|
|
- **Multi-User & SSO**: Granular per-user permissions and isolated reading data, with native support for Authentik, Keycloak, and Authelia via OIDC.
|
|
- **Content Delivery**: OPDS support for compatible apps, Send-to-Kindle via email, and browser drag-and-drop uploads.
|
|
- **Automated Ingestion**: Configure a Book Dock drop folder for hands-free importing.
|
|
|
|
---
|
|
|
|
## Quick Start (Docker)
|
|
|
|
```bash
|
|
mkdir bookorbit && cd bookorbit
|
|
mkdir -p books data/app data/postgres
|
|
curl -fsSLo .env https://raw.githubusercontent.com/bookorbit/bookorbit/main/.env.example
|
|
curl -fsSLo docker-compose.yml https://raw.githubusercontent.com/bookorbit/bookorbit/main/docker-compose.yml
|
|
```
|
|
|
|
Edit `.env` and set these required values:
|
|
|
|
```dotenv
|
|
APP_URL=http://your-server-ip:3000 # the URL you'll open in your browser
|
|
BOOKS_HOST_PATH=./books # folder on your server where your book files live
|
|
|
|
POSTGRES_PASSWORD= # database password - openssl rand -hex 24
|
|
JWT_SECRET= # signs login tokens - openssl rand -hex 32
|
|
SETUP_BOOTSTRAP_TOKEN= # one-time setup wizard token - openssl rand -hex 16
|
|
```
|
|
|
|
Then start:
|
|
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
Open `http://your-server-ip:3000` and complete setup using your `SETUP_BOOTSTRAP_TOKEN`.
|
|
|
|
For the full installation guide including reverse proxy setup, file permissions on NAS, external databases, and environment variable reference, see **[bookorbit.app/installation](https://bookorbit.app/installation.html)**.
|
|
|
|
---
|
|
|
|
## Documentation and Contributing
|
|
|
|
Full documentation is at **[bookorbit.app](https://bookorbit.app/what-is-bookorbit.html)** - covering libraries, metadata, readers, Kobo sync, OPDS, users and permissions, OIDC setup, and more.
|
|
|
|
For local development, see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md). To contribute, see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for the full workflow: branch naming, test expectations, PR checklist, and commit format.
|
|
|
|
---
|
|
|
|
## Support
|
|
|
|
- **Questions and discussion:** [GitHub Discussions](https://github.com/bookorbit/bookorbit/discussions)
|
|
- **Bug reports:** [GitHub Issues](https://github.com/bookorbit/bookorbit/issues/new?template=bug_report.yml)
|
|
- **Feature requests:** [GitHub Issues](https://github.com/bookorbit/bookorbit/issues/new?template=feature_request.yml)
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
BookOrbit is licensed under the **[GNU Affero General Public License v3.0](LICENSE)**.
|