Skip to content

Gextto documentation

This folder holds the documentation maintained together with the code. Start from the manual in the language you prefer; the other documents cover specific needs.

These same files are published as a site at https://buzzqw.github.io/gextto/: the pages are built from docs/ at every change, so this index and the site are never two different texts.

Quick links: Manuale italiano · English manual · Visita guidata · Guided tour · HTTP API · Changelog · changelog.en.md

Document When to use it
Manuale italiano Setup and day-to-day use of the web UI.
English manual English version of the complete user guide.
Manuale gx-core (Italiano) gx-core senza Gextto: avvio Docker, torrent, Serie e film, profili di qualità, RSS, statistiche e integrazioni, con schermate reali.
gx-core manual English version: gx-core without Gextto, Docker start, torrents, Series & movies, quality profiles, RSS, statistics and integrations, with real screenshots.
Visita guidata Screenshots of the main screens, generated with make screenshots.
Guided tour English version of the screenshot tour.
Changelog (italiano) What changed for users, day by day.
Docker: stack completo (Italiano) Gextto, gx-torrent, Jackett, Prowlarr, FlareSolverr e aMule in un solo docker compose; avvio, configurazione, aggiornamento e problemi comuni.
Docker: full stack English version: Gextto, gx-torrent, Jackett, Prowlarr, FlareSolverr and aMule in one docker compose; start, configuration, updating and troubleshooting.
Changelog (English) English version of the user-facing changelog.
Chiavi di accesso The Gextto API key and the gx-torrent token: what they are, how to generate and use them.
Access keys English version: the Gextto API key and the gx-torrent token.
Guida avanzata (Italiano) NAS, permissions, proxy, backup and diagnostics.
Advanced guide English advanced-operation guide.
HTTP API The route tables of the Gextto daemon and of the gx-torrent daemon (/api/v1 and /api/v2) for automations and integrations.
Migration A safe move from a previous install.
qBittorrent-nox for Gextto How to install and configure the qBittorrent-nox backend: Web UI, settings, path mapping, what Gextto drives, managed mode, switching, troubleshooting and the capability gaps.
Security Network exposure, secrets and vulnerability reporting.
Accessibility Keyboard, screen reader, automated axe tests and the manual checklist for the web UI, the gx-torrent page and the TUI.
TUI Terminal client and keyboard shortcuts.
Developers Build, tests and contributor conventions.
Architecture Map of the code folders and files.
Open items The maintained TODO list: what is not done and the gate that unblocks it.
Measurements and benchmarks gx-torrent compared with qBittorrent, Transmission, Deluge, rain and anacrolix/torrent, how to repeat the comparison, then Gextto's own footprint, build and test times, and the designs closed by a measurement.
gx-torrent engine Technical document of the pure-Go torrent engine (gx-core, daemon, adapter).
eD2k e Kad con aMule (Italiano) Italian version: install and configure aMule, enable it in Gextto, use eD2k/Kad, troubleshooting and settings.
eD2k and Kad through aMule How to install and configure aMule, enable it in Gextto and use eD2k/Kad: search, links, aMule's queue in Downloads, completion, shared limits, troubleshooting, settings and tests.
BEP compliance Which BitTorrent specifications (BEPs) the engine supports, which are missing and the roadmap.
gx-core The standalone torrent client (the gx-torrent binary used without Gextto): modes, security, packaging, what is still open.
SQL maintenance scripts Ready-to-run queries and the Maintenance tab for the release archive: old/language-filtered releases, diagnostics and their manual deletion.

[!NOTE] The paths, ports and commands here are examples. Always check the service user, the NAS mount and the permissions in your real install.