soubarnak
ea7be5f111
The fork takes its own name everywhere a user can see it: binaries (voculinux, voculinux-gui), desktop entry, autostart, tray, D-Bus namespace (com.voculinux.Voculinux, no alias for the old name), config/data/cache dirs, single-instance lock, IBus engine identity, tray icons, resource prefixes, VOCULINUX_* environment names, and the update-checker user agent. The internal Python module stays vocalinux and the distribution metadata keeps the upstream URLs as provenance. On first run a previous Vocalinux install's config.json, custom dictionary, and portal restore token are copied once into the new locations (new config always wins, no merge, no write-back); models re-resolve through the pinned-checksum download path. An offline naming-sweep test proves no old-name strings remain on user-visible surfaces outside the allowlist. Refs #18
82 lines
2.6 KiB
Markdown
82 lines
2.6 KiB
Markdown
# Voculinux for Nix
|
|
|
|
A flake that builds Voculinux against nixpkgs: GTK 3, PyGObject and the
|
|
AppIndicator typelib come from nixpkgs, and `pywhispercpp` — which nixpkgs
|
|
does not package — is built from its PyPI sdist (it vendors whisper.cpp and
|
|
pybind11). Every host tool the app probes for (`xdotool`, `wtype`, `ydotool`,
|
|
`wl-clipboard`, `xclip`, `xsel`, `xprop`, `setxkbmap`, `ibus`, `gdbus`,
|
|
`notify-send`, `paplay`, `aplay`) is wired onto PATH, so the wrapped binary
|
|
behaves like a deb/rpm install with Recommends present.
|
|
|
|
## Try it
|
|
|
|
```bash
|
|
nix run github:VocaHQ/vocalinux
|
|
```
|
|
|
|
or install into a profile:
|
|
|
|
```bash
|
|
nix profile install github:VocaHQ/vocalinux
|
|
```
|
|
|
|
## NixOS
|
|
|
|
```nix
|
|
{
|
|
inputs.voculinux.url = "github:VocaHQ/vocalinux";
|
|
|
|
outputs = { nixpkgs, voculinux, ... }: {
|
|
nixosConfigurations.host = nixpkgs.lib.nixosSystem {
|
|
modules = [
|
|
voculinux.nixosModules.voculinux
|
|
{
|
|
programs.voculinux.enable = true;
|
|
users.users.you.extraGroups = [ "input" "uinput" ];
|
|
}
|
|
];
|
|
};
|
|
};
|
|
}
|
|
```
|
|
|
|
`hardware.uinput` (enabled by the module) covers `/dev/uinput`, which ydotool
|
|
and the evdev backend's keyboard clone need. `input` group membership is a
|
|
per-user decision — it grants read access to every keyboard and pointer
|
|
device, the same trade-off `install.sh` documents. X11 sessions need neither
|
|
and can skip the group lines entirely.
|
|
|
|
## Home Manager
|
|
|
|
```nix
|
|
{
|
|
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
|
inputs.home-manager.url = "github:nix-community/home-manager";
|
|
inputs.home-manager.inputs.nixpkgs.follows = "nixpkgs";
|
|
inputs.voculinux.url = "github:VocaHQ/vocalinux";
|
|
|
|
outputs = { nixpkgs, home-manager, voculinux, ... }: {
|
|
homeConfigurations.you = home-manager.lib.homeManagerConfiguration {
|
|
pkgs = nixpkgs.legacyPackages.x86_64-linux;
|
|
modules = [
|
|
voculinux.homeManagerModules.voculinux
|
|
{ programs.voculinux.enable = true; }
|
|
];
|
|
};
|
|
};
|
|
}
|
|
```
|
|
|
|
Home Manager on NixOS still needs the system-side pieces above (the NixOS
|
|
module handles `hardware.uinput`; group membership stays per-user). On a
|
|
non-NixOS host, `nix profile install` plus the equivalent udev rule and group
|
|
membership from your distro does the same job — see docs/INSTALL.md.
|
|
|
|
## Scope
|
|
|
|
- Default engine whisper.cpp plus the `[vad]` extra (ONNX Runtime) are built
|
|
in. The `vosk`, `whisper`, `parakeet` and `faster_whisper` extras are not
|
|
packaged (PyTorch footprint / not in nixpkgs).
|
|
- `pywhispercpp` is built with `GGML_NATIVE=OFF` — a portable baseline rather
|
|
than `-march=native`, so binaries can move between machines.
|