Self-hosted tabs, chord sheets, and sheet music for bass and guitar. This branch keeps the app focused on finding a song and playing it.
- Song library: search and sort songs, and narrow by instrument or favourites.
- Import and edit: bring in tabs from Songsterr, Ultimate Guitar, Guitar Pro, MusicXML, MIDI, ASCII tab, or ChordPro. Start a blank tab or chord sheet, or add multiple files at once.
- Tab player: play the score with the built-in synth or sync it to an audio file or YouTube recording. Tap bar positions or run Auto-sync to align the score.
- Player views: choose tab, note highway, or split view. Turn on the fretboard to follow the selected track's notes, tuning, and capo.
- Loops: set A/B points, save named sections, and jump back to them while playing.
- Chord sheets: transpose a song, review and strum chord diagrams, and print the sheet.
Standard notation and tab are rendered by alphaTab.
Fretbook grew out of Mr-P4p3r/bass-tab-sync and still imports its songs/ folders.
docker compose up --buildOpen http://localhost:8137. The database and audio live in the fretbook-data volume. A ./songs folder is mounted read-only for bass-tab-sync imports.
Prebuilt images for amd64 and arm64 are published to GHCR. Each release (vX.Y.Z, listed in CHANGELOG.md and on the releases page) gets the tags X.Y.Z and X.Y; every push to main gets latest, main and sha-<commit>.
docker pull ghcr.io/liftedkilt/fretbook:latest # newest main
docker pull ghcr.io/liftedkilt/fretbook:0.1.3 # a release; pin this oneUpgrading. Back up the /data volume, read the changelog, then docker compose pull && docker compose up -d. Migrations run on start and are not reversible; see Upgrading.
Python 3.12, Node 22, and ffmpeg (only for downloading YouTube audio).
./run.sh # creates .venv, builds the web app, starts on http://127.0.0.1:8137For development, see CONTRIBUTING.md.
The full documentation is at https://liftedkilt.github.io/fretbook/, built from docs/ on every release:
- Docker Compose, reverse proxy and HTTPS (Caddy, Traefik, nginx, Zoraxy; HTTPS is needed for the microphone), sign-in with OIDC (Pocket ID, Authelia, Authentik, Keycloak), the job worker, backups and restore, upgrading.
- Importing songs, playing and syncing, and installing it for offline use.
- Configuration reference: every
FRETBOOK_*variable. It is generated fromfretbook/config.py(seedocs/reference/configuration.md).
Without sign-in, anyone who can reach the port can use the library, so keep a no-login server on a trusted network or behind an authenticating proxy. To report a vulnerability, see SECURITY.md.
To build the docs locally: pip install -r requirements-docs.txt && mkdocs serve. cd web && npm run docs:screenshots regenerates the screenshots.
- ROADMAP.md: what is planned, and what is already being built.
- CONTRIBUTING.md: development setup, checks, working on an issue, dependency updates, and adding a locale.
- AGENTS.md (CLAUDE.md): how coding agents pick up, claim, and finish issues, plus the PR template and issue templates.
- docs/ARCHITECTURE.md: how the app is built, the stored score format, and API conventions.
MIT. See LICENSE.