Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 1.68 KB

README.md

File metadata and controls

50 lines (41 loc) · 1.68 KB

waybar-tailscale

VPN

A super simple module to show and toggle the status of Tailscale on Waybar.

Installation

At first, you need to be able to use tailscale without using sudo. You can do that by executing:

tailscale set --operator=$USER

After, you can simply clone the repository in your waybar's configuration folder, or where you prefer.

Configuration

In your config file add a new module as the example below.

"custom/tailscale" : {
    "exec": "~/.config/waybar/scripts/waybar-tailscale/waybar-tailscale.sh --status",
    "on-click": "exec ~/.config/waybar/scripts/waybar-tailscale/waybar-tailscale.sh --toggle",
    "exec-on-event": true,
    "format": "VPN: {icon}",
    "format-icons": {
        "connected": "on",
        "stopped": "off"
    },
    "tooltip": true,
    "return-type": "json",
    "interval": 3,
}

Important! Be sure to insert the correct path to the script in the exec and on-click fields. The script is executed every three seconds, but you can easily change it by modifying the interval field.

Exit node

exit-node can be included by changing the format key to:

"format": "VPN: {icon} exit-node: {}",

Colored tooltip

The status flag takes two optional parameters

waybar-tailscale.sh --status "#a6e22e" "#f92672"

The first being the color of active nodes, the second the color of inactive nodes. defaults are respectively green and red.

Contributing

Even if this is a very trivial module, requests for new features and any issues you might find are welcomed.