Documentation
Where to find what you need
The documentation lives with the code, on GitHub, so it always matches the release. Start with the task you have in mind.
The guides are in English, except the complete user guide, which is in French.
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 and the settings you can change in the interface. docs/configuration.md
- Operations Update, monitor, control costs, 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 can be restored. docs/backup.md
- Codex and ChatGPT Translate with Codex models, through an API key or a ChatGPT account. docs/codex.md
- OpenViking Add OpenViking as an external memory for your books and series. docs/openviking.md
Use Libris
- User guide (French) The whole interface, from the library to exports, series and API tokens. docs/user-guide.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
- Automation API Send books or chapters from a script and get the translation back. docs/api.md
Understand and contribute
- Architecture Components, the path of a book, the data model and the security design. docs/architecture.md
- Development Development environment, tests, CI and releases. docs/development.md
- Design system Tokens and components for interface screens that match the rest of Libris. docs/design-system.md
- Contributing How to propose a change. CONTRIBUTING.md