Documentation
Technical documentation
The guides below are the ones shipped with Libris Translate, published here as they stand in the release. Each page names the source revision it comes from; snapshots of work in progress are marked as such.
User and operator guides are published in both languages when a translation exists. The full user guide and the library publication guide are written in French; developer documents are in English.
Results are listed below the field as you type. Move through them with the up and down arrows, open one with Enter, close the list with Escape.
Read this documentation through MCP
An assistant can search and read the public Libris Web pages through a dedicated MCP server. Configure a remote HTTP server at:
https://libris-translate.com/docs-mcp
The search_docs and get_doc tools return excerpts, pages and URLs to cite. No token is needed: only public content is available. The index automatically follows the version published here. Your Libris installation's MCP, described under Integrations, is separate.
Install and run
- Install with Docker Install, sign in, connect a model and translate a first book. Network and HTTPS access, updates, removal, troubleshooting. docs/docker.md
- Configuration reference Every environment variable, from cost budgets to the fair queue and the analysis mode, and the settings you can change in the interface. docs/configuration.md
- Operations Update, monitor, keep costs in check, read logs and troubleshoot a running installation. docs/operations.md
- Backup and restore Back up the database and the books, and check that a backup actually restores. docs/backup.md
- Codex and ChatGPT Translate with Codex models, through an API key or a ChatGPT account. docs/codex.md
- OpenViking Use OpenViking as an external memory for your books and series, and clean it up when they are deleted. docs/openviking.md
- LDAP and Active Directory Connect a directory securely, test it, map its groups, and see how directory identities differ from local accounts. docs/ldap.md
Use Libris Translate
- User guide (French) The whole interface, from the library to exports: series, the chapter map, quality, budgets, shared glossaries, the queue and API tokens. docs/user-guide.fr.md
- Library publication (French) Deliver finished books to a folder watched by Calibre-Web, Komga or Kavita, or to a WebDAV server owned by an account. docs/publication.fr.md
- The autopilot What happens between import and the finished book, how failures are handled, and how to turn it off. docs/autopilot.md
- Quality judge Have a model of another provider read each translated passage and correct the errors it finds: what it looks for, what it costs, how to choose it for the installation or a book. docs/quality.md
- Automation API Send books or new chapters from a script and get the translation back. docs/api.md
- The MCP server Drive the installation from opencode, Claude Code or Codex: the tools, the scopes to give a token, and what an agent can never do. docs/mcp.md
- OpenAPI description The contract of the automation API in OpenAPI 3.1, for OpenAPI tools and client generators. docs/openapi/libris-v1.json
- Example client A Python client that only uses the standard library: send, wait, download, and receive webhooks. examples/libris_client.py
Understand Libris Translate
Project
The guides above can be read online; the OpenAPI description and the example client can be downloaded. Files referred to as source code are part of your installation. Questions: licences@libris-translate.com.