Skip to content

v1.0.0: first stable release

Choose a tag to compare

@mathys-lopinto mathys-lopinto released this 18 Apr 08:21
· 87 commits to master since this release
34c89de

Tabby Sync Version 1.0.0 - Stable

First stable release of tabby-sync. A minimal self-hostable backend for the Tabby terminal's config sync feature, forked from tabby-web and stripped down to the three endpoints the desktop client actually calls.

Highlights

Minimal by design

About 360 lines of application Python around Bearer-token sync, plus 130 lines of Django settings. No web terminal, no OAuth providers, no WebSocket gateway, no app distribution, no analytics. Eight production dependencies total.

HTTPS by default

A plain docker compose up -d boots Django, Postgres and Caddy together. Caddy is the only published entry point on ports 80/443/443-udp with automatic Let's Encrypt certificates. The backend container has no exposed port and is not reachable from outside the Docker network. A separate overlay is available for local development without TLS.

Sync tokens hashed at rest

Tokens are stored as SHA-256 hashes. The cleartext is displayed exactly once at creation or on explicit rotation through a dedicated admin page or the CLI. A database dump does not expose usable tokens.

Admin and CLI provisioning

Sync users are created through the Django admin with a dedicated token display page and a Regenerate button, or through two management commands designed to be piped directly in scripts:

TOKEN=$(docker compose exec -T tabby /app/manage.sh create_sync_user alice)
TOKEN=$(docker compose exec -T tabby /app/manage.sh refresh_token alice)

Tested and covered

170 unit and integration tests with 100% line coverage on the application code, gated by the CI pipeline. Every tag push builds and publishes a multi-tagged Docker image to GHCR.

Install

cp .env.example .env
# Fill in DB_PASSWORD, DJANGO_SECRET_KEY, DOMAIN and ACME_EMAIL
docker compose up -d
docker compose exec tabby /app/manage.sh createsuperuser

Open https:///admin/, create a sync user, copy the token from the display page, paste it into Tabby desktop under Settings > Config sync.

Image

docker pull ghcr.io/mathys-lopinto/tabby-sync:1.0.0
docker pull ghcr.io/mathys-lopinto/tabby-sync:1.0
docker pull ghcr.io/mathys-lopinto/tabby-sync:latest

Upgrade from beta

No migration added since 1.0.0b3. Existing users, tokens and configs are untouched. The :latest tag now points at a stable release.

Known limitations

  • No app-level rate limiting or brute-force protection on the admin login. Run behind a VPN, an IP allowlist or a WAF when exposing the admin publicly.
  • Django admin is the only browser-accessible UI. Sync-only users should never be granted is_staff or is_superuser.

Thanks

This project is a fork of https://github.com/Eugeny/tabby-web by https://github.com/Eugeny. The upstream MIT license and copyright notice are preserved.