Skip to content

VocaGateway 0.1.0

Latest
Latest

Choose a tag to compare

View all tags
@jatinkrmalik jatinkrmalik released this 18 Aug 08:12
· 37 commits to main since this release
v0.1.0
1542506
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

VocaGateway 0.1.0

First public GitHub Release. Early optional self-hosted transcription for the Voca family.

Run it on hardware you control. Pair a phone with a QR code. Audio leaves the client and goes to that host. This is not on-device processing, and it is not a Voca cloud. There is no Voca account.

License: AGPL-3.0. Contact: hello@vocahq.com. Discord: https://discord.gg/UMJduhcqn

Landing: https://vocagateway.vocahq.com
Source and deploy guide: https://github.com/VocaHQ/vocagateway

Install

Native (uv):

git clone https://github.com/VocaHQ/vocagateway.git
cd vocagateway
uv sync --all-groups --extra engines   # add --extra apple on Apple silicon
uv run vocagateway

Docker Compose (Linux amd64/arm64):

docker compose up --build

Default port is 8765. Prefer a trusted LAN, Tailscale, or HTTPS. Do not expose 8765 to the public internet.

What you get

  • Authenticated WebUI for setup, models, engine selection, mic test, and status
  • QR pairing: {"v":1,"url":"...","token":"..."}
  • 58-model catalog (40 pinned)
  • Engines: auto, vocamac, handy, mlx-audio, whisperkit, sherpa-onnx, faster-whisper, moonshine, whisper.cpp
  • Native macOS and Linux, plus Compose profiles for portable CPU, native, CUDA, and Vulkan
  • Env and paths: VOCAGATEWAY_*, ~/.config/vocagateway/, ~/.local/share/vocagateway/
  • Pairing and env contract: docs/configuration.md

Naming

Primary CLI is vocagateway (also vocagateway-token, vocagateway-status, and friends). Package and local image are vocagateway. systemd/LaunchAgent ids are com.vocahq.vocagateway.

Deprecated aliases (vocaphone-server, vocaphone-token, and the rest) still work for one cycle. Prefer the vocagateway* names.

The phone wire hint vocaphone-pair-v1 is unchanged on purpose.

Consumers

  • VocaPhone vendors this repo as server/
  • Desktop apps (Linux / macOS / Windows): Planned. They do not ship a gateway launcher yet.

In this tag

  • Early docs honesty, pairing contract, and path cleanup (#16)
  • Public landing on GitHub Pages at vocagateway.vocahq.com (#17)
  • Rename leftover vocaphone-* CLI, package, and unit names, with aliases (#18)
  • Package version 0.1.0 and family-style README shields (#19)

Not in this release

  • No published container registry image yet (build locally or with Compose)
  • No PyPI package
  • No desktop embed
  • No hosted Voca cloud

Tag matches pyproject.toml version 0.1.0 on main.

Assets 2
Loading