guardllamanet / guardllama

The Ultimate Open-Source VPN, Ad-blocker and DNS resolver :llama::shield:

GuardLlama - The Ultimate Open-Source VPN, Ad-blocker and DNS resolver 🦙🛡️

GuardLlama is a cutting-edge open-source platform that redefines online protection by integrating a VPN, a firewall, an ad-blocker, and a validating, recursive, and caching DNS resolver. This comprehensive solution allows you to create a self-hosted WireGuard VPN with a built-in firewall and ad-blocking capabilities, empowering you to control your online privacy and security fully.

Features 🌟

• Effortless installation and setup
• End-to-end encryption with WireGuard VPN
• Powerful ad-blocking capabilities
• Robust firewall to block unwanted traffic and potential threats
• Built-in validating, recursive, and caching DNS resolver
• Open-source, Transparent, and community-driven

Demo 🎉

Getting Started 🚀

Prerequisites

1. A Linux server to host GuardLlama (follow the provisioning guide).
2. Basic knowledge of Linux server administration.

Installation

1. Install GuardLlama on your server by following the installation guide.
2. Connect to your VPN server using the connection guide.
3. Configure a personalized VPN tunnel with the configuration guide.

Community & Support 💬

Need assistance with GuardLlama?

• Community Forum: Ideal for help with building and discussing GuardLlama.
• Github Issues: For reporting bugs and requesting features encountered while using GuardLlama.
• Twitter: Stay up-to-date with the latest GuardLlama news.
• Discord: Connect with the community, share your applications, and hang out.

Contributing 🤝

We greatly appreciate contributions from the community! If you're interested in contributing to GuardLlama, please see our contribution guidelines for more information on how to get involved.

License 📄

GuardLlama is licensed under the Apache 2.0 License.

Acknowledgements 🙌

This software wouldn't have been possible without the incredible work of several open-source projects, including:

• WireGuard
• AdGuardHome
• Unbound
• K3S

---

GuardLlama - Reclaim your safe internet experience today! 🦙🛡️

guardllama's Issues

Bug: Radxa Rock 5 ARM64 fails to initialize wg tunnel pod

Please provide a clear and concise description of the issue you are experiencing with GuardLlama.

While trying to install GuardLLama on a Rock 5 (raspberry pi like SBC), WG pod fails to initialize.
The OS installed is a custom build of Ubuntu Focal
uname -v = #rockchip SMP Mon Feb 6 09:18:21 UTC 2023

Please provide the steps to reproduce the issue.

1. install via: curl -sfL https://get.guardllama.net | sh -
2. access web ui
3. add tunnel

Please describe the behavior you expected when performing the steps above.

init-wireguard-module.sh theoretically should work with arm64 ubuntu focal

Please describe the actual behavior you observed when performing the steps above.

Pods fail to initialize

Please provide any additional information or screenshots that might help us understand and resolve the issue.

wg tunnel pod logs:

sudo k3s kubectl logs --namespace=home wg-home-6bb967458-2gpv2
[INFO] Running iptables in legacy mode
Uname info: Linux wg-home-6bb967458-2gpv2 5.10.110-37-rockchip-g74457be0716d #rockchip SMP Mon Feb 6 09:18:21 UTC 2023 aarch64 aarch64 aarch64 GNU/Linux
Error: Unknown device type.
[INFO] Wireguard module is not active, attempting kernel header install and module compilation. If you believe that your kernel should have wireguard support already, make sure that it is activated via modprobe!
[INFO] Attempting kernel header install.
Get:1 http://ports.ubuntu.com/ubuntu-ports jammy InRelease [270 kB]
Get:2 http://ports.ubuntu.com/ubuntu-ports jammy-updates InRelease [119 kB]
Get:3 http://ports.ubuntu.com/ubuntu-ports jammy-backports InRelease [108 kB]
Get:4 http://ports.ubuntu.com/ubuntu-ports jammy-security InRelease [110 kB]
Get:5 http://ports.ubuntu.com/ubuntu-ports jammy/universe arm64 Packages [17.2 MB]
Get:6 http://ports.ubuntu.com/ubuntu-ports jammy/multiverse arm64 Packages [224 kB]
Get:7 http://ports.ubuntu.com/ubuntu-ports jammy/main arm64 Packages [1758 kB]
Get:8 http://ports.ubuntu.com/ubuntu-ports jammy/restricted arm64 Packages [24.2 kB]
Get:9 http://ports.ubuntu.com/ubuntu-ports jammy-updates/multiverse arm64 Packages [24.3 kB]
Get:10 http://ports.ubuntu.com/ubuntu-ports jammy-updates/main arm64 Packages [1190 kB]
Get:11 http://ports.ubuntu.com/ubuntu-ports jammy-updates/universe arm64 Packages [1018 kB]
Get:12 http://ports.ubuntu.com/ubuntu-ports jammy-updates/restricted arm64 Packages [547 kB]
Get:13 http://ports.ubuntu.com/ubuntu-ports jammy-backports/main arm64 Packages [48.9 kB]
Get:14 http://ports.ubuntu.com/ubuntu-ports jammy-backports/universe arm64 Packages [23.6 kB]
Get:15 http://ports.ubuntu.com/ubuntu-ports jammy-security/main arm64 Packages [844 kB]
Get:16 http://ports.ubuntu.com/ubuntu-ports jammy-security/universe arm64 Packages [772 kB]
Get:17 http://ports.ubuntu.com/ubuntu-ports jammy-security/restricted arm64 Packages [507 kB]
Get:18 http://ports.ubuntu.com/ubuntu-ports jammy-security/multiverse arm64 Packages [20.2 kB]
Fetched 24.8 MB in 6s (4305 kB/s)
Reading package lists...
E: No packages found
[INFO] No kernel headers found in the Ubuntu or Debian repos!! Will try the headers from host (if mapped), may or may not work.
[INFO] Kernel headers don't seem to be available in Ubuntu, Debian and Raspbian repos, or shared from the host; therefore can't compile the module. Falling back to wireguard-go.
time=2023-04-26T04:17:30.354Z level=INFO msg="Starting tunnel server" addr=:8080
time=2023-04-26T04:17:30.358Z level=INFO msg="Execing command" command="/usr/bin/wg-quick up wg0"
[#] ip link add wg0 type wireguard
Error: Unknown device type.
[!] Missing WireGuard kernel module. Falling back to slow userspace implementation.
[#] wireguard-go wg0
/usr/bin/wg-quick: line 32: /usr/bin/wireguard-go: cannot execute binary file: Exec format error
Unable to access interface: Protocol not supported
[#] ip link delete dev wg0
Cannot find device "wg0"
Error: exit status 1
Usage:
  glmmgr wg [flags]

Flags:
  -h, --help                   help for wg
      --http-addr string       the address that tunnel endpoint binds to (default ":8080")
      --tunnel-config string   path to tunnel config

Global Flags:
      --config string   config file
      --debug           debug

time=2023-04-26T04:17:30.465Z level=ERROR msg="error executing command" error="exit status 1"

Please provide the version of GuardLlama you are using.

glm-installer 1.1.0 (2023-04-16)

OS

Ubuntu Server 20.04

Cloud Provider

N/A

VPN Client

N/A

Feature: Customize the web dashboard port

Feature description

I'm using this on a machine with other things already on it (along with nginx), and so it'd be nice if I could change the port to something else.

Feature: Default UDP port to 30001 - 30005

Feature description

Opening UDP port 30000 - 32768 is too wide open. Let's default it to only 5 ports (30000 - 30005) with 5 tunnels.

Bug: Traefik takes up vpn node port range

Please provide a clear and concise description of the issue you are experiencing with GuardLlama.

Traefik takes up the VPN node port range. This adds two extra port to the range to make up for Traefik but it randomly takes two ports in the range that are meant to be for the VPN node ports.

Please provide the steps to reproduce the issue.

N/A

Please describe the behavior you expected when performing the steps above.

Traefik uses reserved node ports: 32080 for 80 & 32443 for 443.

Please describe the actual behavior you observed when performing the steps above.

Traefik randomly takes two ports in the range that are meant to be for the VPN node ports.

Please provide any additional information or screenshots that might help us understand and resolve the issue.

No response

Please provide the version of GuardLlama you are using.

1.2.5

OS

Any

Cloud Provider

Any

VPN Client

Any

Bug: Custom lists failure

Please provide a clear and concise description of the issue you are experiencing with GuardLlama.

When i customize the blocklists in Adguard, everything works but after a certain time, all the blocklists i added are gone and only the 2 initial lists are there. Other settings made in adugard home are saved.

Please provide the steps to reproduce the issue.

1. Add custom blocklists
2. wait (some hours)
3. see the results

Please describe the behavior you expected when performing the steps above.

The lists should be saved accordingly

Please describe the actual behavior you observed when performing the steps above.

Lists were gone

Please provide any additional information or screenshots that might help us understand and resolve the issue.

No response

Please provide the version of GuardLlama you are using.

1.2.5

OS

Ubuntu 20.04

Cloud Provider

Contabo

VPN Client

Wireguard for Windows, iOS and Android

Feature: expose the AGH dashboard

Feature description

Expose the AGH dashboard if people find the GuardLlama dashboard insufficient to configure DNS filtering.

Feature: White list or black list entries from logs

Feature description

It would be nice to be able to whitelist websites from logs

Feature: allow choosing filtering DNS between AdGuardHome or Pihole

Feature description

When creating a tunnel, it would be nice to choose the filtering DNS between AdGuardHome or Pihole. Some users would prefer one or the other, and we should support them.

Ref: https://www.reddit.com/r/WireGuard/comments/12ofc92/comment/jgkaenw/?utm_source=reddit&utm_medium=web2x&context=3

Feature: Customize block lists

Feature description

It would be nice to be able to customize block lists. It would also be great to be able to update frequency.

Ref: https://www.reddit.com/r/WireGuard/comments/125s9j7/comment/je7o3ug/?utm_source=reddit&utm_medium=web2x&context=3

Bug: When attempting show password token it does not show characters

Please provide a clear and concise description of the issue you are experiencing with GuardLlama.

When you enter your token in ui login section and press show button the characters it does not show chracters.

Please provide the steps to reproduce the issue.

1-Enter your vps ip
2-Copy paste your token to web ui token section
3-Press show button
4-Password token not shown.

Please describe the behavior you expected when performing the steps above.

It should show password with characters

Please describe the actual behavior you observed when performing the steps above.

There are when you enter password and not showing password i could not found the term but when you enter your password and it shown black dots.

Please provide any additional information or screenshots that might help us understand and resolve the issue.

No response

Please provide the version of GuardLlama you are using.

1.2.5

OS

Fedora

Cloud Provider

Digital ocean

VPN Client

.

Refresh JWT token on API calls

Feature description

JWT tokens are issued when calling POST /authenticate once, and the expiration date is never renewed. This would make the user session expire in one hour after a user logs in. API calls should refresh the JWT token in the response header and the UI should update the cookie so that user session stays active if the user stays active.

Feature: Allow customizing UDP ports during installation

Feature description

Allow customizing UDP ports during installation