Getting started
-
Sign in as admin / admin and change the password in your profile right away. To switch the interface to English, press EN in the top bar.
-
Add a source. Admin → Book sources → Add source: the path to a
.inpxfile, to a Calibre library or to a folder with books. In Docker, use the path inside the container, e.g./library. -
Wait for indexing. Progress is shown in the admin panel; a collection of hundreds of thousands of books takes about 45 minutes. The server keeps responding meanwhile.
-
Create users in Admin → Users, or turn on anonymous access there.
-
Mail and Telegram (optional). To send books to e-readers, fill in Admin → Mail; for the bot, Admin → Telegram bot.
-
Backup. Admin → Backup — a portable copy of user data (see below).
Backup
Section titled “Backup”The catalog can always be rebuilt from the sources, so a backup holds the user data: users, settings, sources, shelves and smart shelves, favorites, finished books, reading positions, bookmarks and notes. Books are matched by a file fingerprint, so a backup also works after a full reindex.
- A daily copy with rotation is on by default (the last 7 are kept).
- A backup password encrypts every copy (AES-256-GCM) and only then carries secrets — SMTP, bot token, OIDC. Without a password the file is plain and has no secrets.
- Restore from an uploaded file or a stored copy; there is a dry-run check that writes nothing.
Where things live
Section titled “Where things live”| What | Where |
|---|---|
| Database, settings, cover cache | data/ (the inpx-data volume in Docker) |
| Server log | data/runtime.log |
| Health check | http://<server>:3000/health |
