Skip to content

Installing lueur

lueur is a designed to be easily installed on major systems such as Linux, macOS and Windows. We provide a variety of approaches to install lueur depending on your environment.

Download the lueur binary

The most direct route is to download the lueur binary on your machine.

  • Download lueur

    You can download the appropriate lueur-cli binary for your platform from here.

  • Ensure lueur can be found in your PATH

    export PATH=$PATH:`pwd`
    
    $env:Path += ';C:\directoy\where\lueur\lives' 
    
  • Turn the binary into an executable

    On Linux and macOS you will need to make sure the binary gets the executable permission flipped on with:

    chmod a+x lueur
    

Stealth Dependencies

lueur stealth mode requires additional dependencies only available on Linux.

  • Download lueur with ebpf support

    Instead, of lueur-cli, you will need to download and run lueur-cli-ebpf which comes with the appropriate stealth mode enabled.

    You can download lueur-cli-ebpf here.

  • Turn the binary into an executable

    On Linux and macOS you will need to make sure the binary gets the executable permission flipped on with:

    chmod a+x lueur
    
  • Download lueur's ebpf programs

    You can download lueur-ebpf-programs from here.

  • Copy them in their default location

    Move the lueur-ebpf binary to $HOME/.local/bin

    mv lueur-ebpf $HOME/.local/bin
    
  • Give privileges to lueur to load and attach these ebpf programs

    eBPF is powerful Linux kernel level feature which requires elevated privileges to be used. While you can always run lueur with sudo, it might be better to set privileges more specifically to the executable:

    sudo setcap cap_sys_admin,cap_bpf,cap_net_admin+ep `$HOME/.local/bin/lueur`
    

Install using cargo

lueur is a rust application. It can be installed using cargo which will recompile it on the machine.

  • Requirements

    lueur expects rust 1.85+ and the nightly channel.

    rustup toolchain install nightly
    
  • Install the lueur executable

    cargo +nightly install lueur
    

Stealth Dependencies

  • Install the lueur executable with stealth mode enabled

    In this case, you need to enable the stealth feature. when installing the lueur executable.

    cargo +nightly install lueur --features stealth
    
  • Install the ebpf binaries on Linux

    cargo +nightly install lueur-ebpf-programs --target=bpfel-unknown-none -Z build-std=core
    
  • Give privileges to lueur to load and attach these ebpf programs

    eBPF is powerful Linux kernel level feature which requires elevated privileges to be used. While you can always run lueur with sudo, it might be better to set privileges more specifically to the executable:

    sudo setcap cap_sys_admin,cap_bpf,cap_net_admin+ep `$HOME/.cargo/bin/lueur`