Open-source Dyslibria docs
Choose the route that matches your setup: run the full self-hosted library or integrate the converter package into your own tools.
Self-hosted
Self-hosted Dyslibria
Bring up the full open source library on your own server and give readers a place to browse, read, and return to their books.
Best for
Readers, households, schools. Full control of the library.
Start here
Self-hosted library overviewTurn Dyslibria into a private reading home where people can browse books, pick up where they left off, and use OPDS or WebDAV without handing the library to somebody else.Install with DockerIf you want the easiest path to a proper self-hosted library, Docker gets you there quickly and keeps the important folders safe from the start.First-run setup and initial configurationUse the bootstrap login once, create the real administrator account, and set the basics before other people start using the library.Accounts, roles, and access controlCreate reader-only accounts for day-to-day reading, keep administrator access limited, and reset passwords from one place.NPM package
dyslibria-converter
Developer documentation for the published Node.js package, including the API, CLI, logging, errors, and release workflow.
Best for
Developers integrating Dyslibria into scripts, apps, workers, or CI.
Start here
Package quick startInstall `dyslibria-converter`, run it from Node.js or the CLI, and understand the runtime expectations before you wire it into your own tools.Node.js API referenceUse file paths, buffers, streams, or custom converter instances depending on the shape of your own application.Inspection, logging, and error handlingInspect EPUBs before conversion, stream structured log events into your own observability tooling, and respond to package-specific error classes.CLI usageUse the CLI for quick local conversions, inspection runs, and simple shell-driven workflows without writing any Node code.