Getting started

Getting started with TraDoc

Choose an installation method and complete a first controlled translation.

Two paths are supported:

  • Docker, recommended for a NAS or long-running server. The repository docker-compose.yml pulls the published GHCR image; an explicit build override is available for source builds.
  • Local development, recommended when modifying TraDoc or testing it from source. Requires Node.js 22.
  1. Check the requirements.
  2. Follow the quick installation.
  3. Open the interface and choose a provider.
  4. Test the connection and a short paragraph.
  5. Import a small document before processing a complete book.

The demo is not an installation

The public demo reproduces the interface in your browser, with no backend, uploaded file or real provider.

License and project

MIT license, source repository and contribution rules.

Requirements

Hardware, software, network and provider requirements before installation.