Run a server
This shelf is for whoever runs Bookclerk for a household: the daemon, its configuration, the plugins it loads and the HTTP API it serves. To try Bookclerk on your own computer first, see Getting started.
- Running Bookclerk: the daemon, systemd, Docker and logs.
- Configuration:
config.toml, environment variables and plugin settings. - Security checklist: keys, TLS, sign-in and isolation before you expose a server.
- Database: SQLite, PostgreSQL or Cloudflare D1, and encrypted secrets.
- Stores reference: store plugins, formats and settings.
- Output and destinations reference: local and S3 destinations, naming and packaging.
- Drop folders: a watched folder whose books Bookclerk adds to the library.
- Web app and sign-in reference: roles, sign-in methods, routes and screens.
- Integrations and sign-in: Audiobookshelf, invites and identity providers.
- Managing plugins: install, approve, configure and place plugins; isolation modes.
- Libraries and branches: join a library, branches on its database and consent.
- Notifications: channels, routes, patron choices, the inbox and the delivery log.
- Public address: reach the library from the internet through an ingress plugin, with no port forwarding.
- Media worker: the confined process that handles audio files.
- Uploads: adding books from files, folders and archives, limits and review.
- Playback reference: what the daemon stores and serves for players.
- Player apps: listen in apps made for Audiobookshelf
servers, through
/player. - Backups, updates, import and export: native backups, schema backups, updating, Libation and PostgreSQL export.
- Diagnostics: opt-in error reports.
- CLI reference: every built-in
bookclerkcommand and option (generated). - Web API: every route the daemon serves, with example requests and responses (generated).
- Use Bookclerk: the web app from a reader's side.
- Build plugins: add a store, a destination or an integration.
Source: docs/server/README.md at main · View as Markdown