Skip to content

naurissteins/Veila

Repository files navigation

Veila

GitHub last commit GitHub repo size AUR Version GitHub Repo stars

Veila is built for wlroots-style compositors like labwc, Niri, Hyprland, Sway, MangoWC and others that support the Wayland ext-session-lock-v1 protocol. Its main goal is to provide a secure, fast and elegant lock screen without relying on heavyweight UI stacks.

veila-preview2

🔥 Features

  • Fast and secure locking with a clean polished UI
  • Multi-monitor support
  • Simple setup with config.toml
  • Built-in themes plus support custom themes
  • Flexible styling for the clock, password field, colors, fonts and more
  • Widgets: weather, battery, now playing, keyboard layout, Caps Lock, avatar and username
  • Color-only backgrounds, wallpaper backgrounds and per-monitor background overrides
  • Preview mode, generate lockscreen to a PNG for screenshots and theme work
  • Lightweight design without a heavy desktop UI toolkit

Install

Arch Linux

On Arch Linux, install Veila from the AUR:

# prebuilt release package (recommended)
yay -S veila-bin

# or latest git build
yay -S veila-git

First launch

Start the daemon:

veilad

Or better run it as a user service with systemd:

systemctl --user enable --now veilad.service

Lock the screen:

veila lock

NixOS

Flake installation:

{
  inputs.veila.url = "github:naurissteins/Veila";

  outputs = { nixpkgs, veila, ... }: {
    nixosConfigurations.my-host = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        veila.nixosModules.default
        {
          programs.veila.enable = true;
        }
      ];
    };
  };
}

The module installs veila, veilad and veila-curtain and configures the required PAM service.

Install directly:

nix profile install github:naurissteins/Veila#veila

Add PAM service:

{
  environment.systemPackages = [
    inputs.veila.packages.${pkgs.system}.default
  ];

  security.pam.services.veila = {};
}

Docs

For full installation, configuration, theming and more, visit:

https://naurissteins.com/veila

About

Secure, elegant and fast Wayland screen locker

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages