{"id":50664944,"url":"https://github.com/saiththerobo/calibre-content-server-startos","last_synced_at":"2026-06-08T05:30:54.052Z","repository":{"id":361152176,"uuid":"1250970522","full_name":"saiththerobo/calibre-content-server-startos","owner":"saiththerobo","description":"StartOS package for Calibre Content Server — self-hosted ebook library with OPDS support","archived":false,"fork":false,"pushed_at":"2026-05-29T10:52:48.000Z","size":55,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-05-29T12:25:35.378Z","etag":null,"topics":["calibre","ebook","opds","s9pk","self-hosted","startos"],"latest_commit_sha":null,"homepage":"https://calibre-ebook.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saiththerobo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-05-27T06:04:27.000Z","updated_at":"2026-05-29T10:36:25.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/saiththerobo/calibre-content-server-startos","commit_stats":null,"previous_names":["saiththerobo/calibre-content-server-startos"],"tags_count":2,"template":false,"template_full_name":"Start9Labs/hello-world-startos","purl":"pkg:github/saiththerobo/calibre-content-server-startos","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saiththerobo%2Fcalibre-content-server-startos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saiththerobo%2Fcalibre-content-server-startos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saiththerobo%2Fcalibre-content-server-startos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saiththerobo%2Fcalibre-content-server-startos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saiththerobo","download_url":"https://codeload.github.com/saiththerobo/calibre-content-server-startos/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saiththerobo%2Fcalibre-content-server-startos/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34050225,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["calibre","ebook","opds","s9pk","self-hosted","startos"],"created_at":"2026-06-08T05:30:52.565Z","updated_at":"2026-06-08T05:30:54.043Z","avatar_url":"https://github.com/saiththerobo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"icon.png\" alt=\"Calibre Content Server Logo\" width=\"21%\"\u003e\n\u003c/p\u003e\n\n# Calibre Content Server on StartOS\n\n\u003e **Upstream repo:** \u003chttps://github.com/kovidgoyal/calibre\u003e\n\nCalibre Content Server is the built-in web server from Calibre, the most popular open-source ebook manager. Browse your library, read books in the browser, upload new titles, and connect any OPDS-compatible reading app — all hosted on your own node.\n\n---\n\n## Table of Contents\n\n- [Image and Container Runtime](#image-and-container-runtime)\n- [Volume and Data Layout](#volume-and-data-layout)\n- [Installation and First-Run Flow](#installation-and-first-run-flow)\n- [Configuration Management](#configuration-management)\n- [Network Access and Interfaces](#network-access-and-interfaces)\n- [Actions (StartOS UI)](#actions-startos-ui)\n- [Backups and Restore](#backups-and-restore)\n- [Health Checks](#health-checks)\n- [Dependencies](#dependencies)\n- [Limitations and Differences](#limitations-and-differences)\n- [What Is Unchanged from Upstream](#what-is-unchanged-from-upstream)\n- [Contributing](#contributing)\n- [Quick Reference for AI Consumers](#quick-reference-for-ai-consumers)\n\n---\n\n## Image and Container Runtime\n\n| Property      | Value                                               |\n| ------------- | --------------------------------------------------- |\n| Image         | Custom Dockerfile (`debian:bookworm-slim` + calibre) |\n| Calibre version | 9.8.0                                             |\n| Architectures | x86_64, aarch64                                     |\n| Entrypoint    | `/opt/calibre/calibre-server`                       |\n\nThe image is built from `debian:bookworm-slim`. The calibre standalone tarball is downloaded from the [official GitHub releases](https://github.com/kovidgoyal/calibre/releases) and extracted to `/opt/calibre`. This gives the full calibre suite (including `ebook-convert` and `calibre-debug`) without the desktop/VNC stack present in `linuxserver/calibre`.\n\n---\n\n## Volume and Data Layout\n\n| Volume  | Mount Point | Purpose                                        |\n| ------- | ----------- | ---------------------------------------------- |\n| `main`  | `/config`   | User database (`users.db`), server state       |\n| `books` | `/library`  | Calibre library (metadata.db + book files)     |\n\n---\n\n## Installation and First-Run Flow\n\n1. On install, a random 22-character admin password is generated and saved to `main/store.json`.\n2. A critical task notification appears prompting you to run **Get Admin Credentials** to retrieve your login.\n3. On first start, a oneshot uses `calibre-debug` to create the `admin` user in `main/users.db` if it does not already exist.\n4. `calibre-server` starts, serves the library at `/library` on port 8080, and marks itself ready once the port is listening.\n\nAn empty library is created automatically by calibre-server if none exists yet.\n\n---\n\n## Configuration Management\n\nNo StartOS-managed config file. All server configuration is passed as CLI flags at startup:\n\n```\ncalibre-server --port=8080 --enable-auth --userdb=/config/users.db /library\n```\n\n---\n\n## Network Access and Interfaces\n\n| Interface | Port | Protocol | Purpose                         |\n| --------- | ---- | -------- | ------------------------------- |\n| Web UI    | 8080 | HTTP     | Calibre Content Server web UI   |\n\nThe same port also serves the OPDS catalog at `/opds`. Connect any OPDS-compatible app (KOreader, Moon+ Reader, etc.) to your node's URL with path `/opds`.\n\n**Access methods:**\n\n- LAN IP with unique port\n- `\u003chostname\u003e.local` with unique port\n- Tor `.onion` address\n- Custom domains (if configured)\n\n---\n\n## Actions (StartOS UI)\n\n| Action                  | Status Filter | Description                                        |\n| ----------------------- | ------------- | -------------------------------------------------- |\n| Get Admin Credentials   | Any           | Returns the `admin` username and generated password |\n\n---\n\n## Backups and Restore\n\n**Included in backup:**\n\n- `main` volume (user database, store)\n- `books` volume (the entire Calibre library)\n\n**Restore behavior:** Both volumes are fully restored before the service starts. The admin password and library are preserved across restores.\n\n---\n\n## Health Checks\n\n| Check         | Method                   | Messages                                                                         |\n| ------------- | ------------------------ | -------------------------------------------------------------------------------- |\n| Web Interface | Port listening (8080)    | Success: \"The web interface is ready\" / Error: \"The web interface is not ready\"  |\n\n---\n\n## Dependencies\n\nNone.\n\n---\n\n## Limitations and Differences\n\n1. **No GUI library management** — the Calibre desktop GUI is not available. Books are managed via the web upload interface or by connecting the Calibre desktop app to the server using its \"Connect/Share\" feature.\n2. **Single admin user** — only the `admin` user is created automatically. Additional users can be added by running `calibre-server --manage-users` on the node directly.\n3. **No riscv64** — the upstream calibre project does not publish a riscv64 binary release.\n\n---\n\n## What Is Unchanged from Upstream\n\n`calibre-server` runs unmodified. No patches are applied. The only difference from running calibre-server manually is that authentication is enabled by default and the admin password is managed by StartOS.\n\n---\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for build instructions and development workflow.\n\n---\n\n## Quick Reference for AI Consumers\n\n```yaml\npackage_id: calibre-content-server\nimage: custom Dockerfile (debian:bookworm-slim + calibre 9.8.0 tarball)\narchitectures: [x86_64, aarch64]\nvolumes:\n  main: /config       # users.db, store.json\n  books: /library     # Calibre library (metadata.db + book files)\nports:\n  ui: 8080            # web UI + OPDS at /opds\ndependencies: none\nauth: enabled, admin user created on first start via calibre-debug\nactions:\n  get-admin-credentials: returns admin username and password\nstartos_managed_env_vars: none\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaiththerobo%2Fcalibre-content-server-startos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaiththerobo%2Fcalibre-content-server-startos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaiththerobo%2Fcalibre-content-server-startos/lists"}