Installation

Most direct ways to install Vicinae on your system. If your system is not listed here can you either install from a release or build from source.

Arch Linux (AUR)

Vicinae is available on the Arch User Repository (AUR) in three variants:

Source build
- vicinae – stable release, compiled from source
- vicinae-git – latest development version, compiled from source
Prebuilt binary
- vicinae-bin – stable release, precompiled binary

You can install Vicinae using your preferred AUR helper.

yay -S vicinae-bin

Nix (Flake)

Vicinae is also available as a Nix flake. You can use the binaries of the Nix package or enable the systemd service provided by the home-manager module.

nix shell github:vicinaehq/vicinae

Home Manager module

# flake.nix
{
    description = "...";
    inputs = {
        vicinae.url = "github:vicinaehq/vicinae";
        ...
    };
    outputs = {
        nixpkgs,
        home-manager,
        vicinae,
    }: let
    system = "...";
    pkgs = nixpkgs.legacyPackages.${system};
    in {
        homeConfigurations."..." = home-manager.lib.homeManagerConfiguration {
            inherit pkgs;

            modules = [
                vicinae.homeManagerModules.default
                ...
            ];
        }
    }
}

# home.nix
# ...
{pkgs}:{
    services.vicinae = {
        enable = true; # default: false
        autoStart = true; # default: true
        package = # specify package to use here. Can be omitted.
    };
}

Gentoo

jaredallard's overlay

Thanks to jaredallard for providing an ebuild!

eselect repository add jaredallard-overlay git https://github.com/jaredallard/overlay.git
emerge --sync jaredallard-overlay
emerge gui-apps/vicinae