Code Monkey home page Code Monkey logo

balena-adguard's Introduction

balena-adguard

If you're looking for a way to quickly and easily get up and running with an AdGuard Home device for your home network, this is the project for you.

This project is a balenaCloud stack with the following services:

  • AdGuard Home is a network-wide software for blocking ads & tracking.

balenaCloud is a free service to remotely manage and update your IoT devices through an online dashboard interface, as well as providing remote access to the AdGuard Home web interface without any additional configuation.

Getting Started

You can one-click-deploy this project to balena using the button below:

deploy with balena

Manual Deployment

Alternatively, deployment can be carried out by manually creating a balenaCloud account and application, flashing a device, downloading the project and pushing it via the balena CLI.

Application Environment Variables

Application environment variables apply to all services within the application, and can be applied fleet-wide to apply to multiple devices.

Name Description
TZ Inform services of the timezone in your location
SET_HOSTNAME Set a custom hostname on application start. Default is adguard.
DNS_INTERFACES Optionally provide a space-separated list of interfaces to bind DNS. For example: eth0 wlan0 tailscale0.
TS_AUTH_KEY Tailscale auth key to join an existing Tailnet. Default is unset.

Usage

Initial setup

Once your device joins the fleet you'll need to allow some time for it to download the application.

Note that joining an Open Fleet does not require a balena account nor does it add the device to your personal balena dashboard. If you would rather manage your device and fleet directly you can fork this fleet.

  1. Connect to http://adguard.local or if that doesn't work http://YOUR-DEVICE-IP:80/install.html in your browser
    • YOUR-DEVICE-IP should be the IP assigned via DHCP from your home router, you can find this IP in your router interface.
  2. Select All interfaces and port 80 for the Admin Web Interface listen interface
  3. Select either eth0 or wlan0 and port 53 for the DNS server listen interface
  4. Provide an admin username and password

Documentation for Adguard Home can be found at https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started

It is recommended that you assign a static IP to your AdGuard Home device via you router or DHCP server if possible!

Encryption setup

https://github.com/AdguardTeam/AdGuardHome/wiki/Encryption

Check out the letsencrypt branch of this repo for instructions on using certbot to automatically generate and renew SSL certificates.

https://github.com/klutchell/balena-adguard/tree/letsencrypt

Acknowledgments

Original software is by AdGuard: https://adguard.com/en/adguard-home/overview.html

balena-adguard's People

Contributors

chemical-soup avatar chrisys avatar dependabot[bot] avatar eiddor avatar klutchell avatar renovate-bot avatar taclog avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

balena-adguard's Issues

Thank you!

Not an issue, so feel free to close, but thank you so much for making this :)

I thought I would have to create the whole build from scratch but it's awesome that someone took the time to create this

🥳🥳🥳

more clarity needed for usage instructions

As someone without a base knowledge of tech terms, it was a bit difficult to follow through the instructions. I did need to google or ask other folks for clarity as to some of the jargon used in the instructions. Simplified yet detailed instructions would be helpful.

When trying to access the device via website, it was unclear as to which website to go to. I wasn't sure how to set a static IP address, or what that even means, for my device or how to access it once it was created, so I ended up using adguard.local which was not included in the documentation.

Also, I thought the device would auto-populate or somehow link to the balena dashboard. It would be helpful to get some direction or disclosure as to how to begin the process to ensure the device is populated in the dashboard from the beginning or at least some warning that it will not populate on its own. I did learn later that this process isn't currently available so I think the disclosure would really add some clarity.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

Renovate tried to run on this repository, but found these problems.

  • WARN: Found renovate config warnings

This repository currently has no open or pending branches.

Detected dependencies

docker-compose
docker-compose.yml
  • balenablocks/hostname latest@sha256:b923d6ea886ec48125d2c49e431638d2ef6f4adac574b729b4135cfade3ffdce
dockerfile
adguard/Dockerfile
  • adguard/adguardhome v0.107.52@sha256:d16cc7517ab96f843e7f8bf8826402dba98f5e6b175858920296243332391589
tailscale/Dockerfile
  • tailscale/tailscale v1.72.1@sha256:83a6faec34866f70914a7d241d6ca749e6914f08f4f9059d942e1c3088dc001b
github-actions
.github/workflows/balena.yml
  • actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
  • balena-io/deploy-to-balena-action v2.0.74@72b7652cd8b4b0b49376f60fe790eef9ba76e3f0
  • ubuntu 22.04

Service boot loop

Trying to set it up using the code exactly as it is and it loops service boot and shutdown.

Killing service 'dns-cloudflare sha256:5057096bc63b3b8e5a6b1fb3947e03ae5ad9404d9e4c4fde9264209e437ff0ea'
25.07.19 13:31:26 (+0200) Service exited 'adguard sha256:08d44956b9e2e6eca6788945fddd73245c537ccd5d14f6799fe0eeac17f63aa5'
25.07.19 13:31:26 (+0200) Restarting service 'adguard sha256:08d44956b9e2e6eca6788945fddd73245c537ccd5d14f6799fe0eeac17f63aa5'
25.07.19 13:30:59 (+0200) <adguard> standard_init_linux.go:207: exec user process caused "exec format error"
25.07.19 13:31:08 (+0200) <adguard> standard_init_linux.go:207: exec user process caused "exec format error"
25.07.19 13:31:21 (+0200) <adguard> standard_init_linux.go:207: exec user process caused "exec format error"
25.07.19 13:31:30 (+0200) Service exited 'dns-cloudflare sha256:5057096bc63b3b8e5a6b1fb3947e03ae5ad9404d9e4c4fde9264209e437ff0ea'
25.07.19 13:31:35 (+0200) <adguard> standard_init_linux.go:207: exec user process caused "exec format error"

Rapsberry 3B+

Variables (extras from my last pihole push)

image

Loved the project, thank you !

I'm running in a raspberry pi zero v1, and by the moment it's running well :)

I'm thinking in fork the project and add cloudflare tunnel container, so I can enter in the AdGuard dashboard remotely

Service Exit loop

HI I am trying to setup two projects on one unit as shown here:
https://www.balena.io/blog/two-projects-one-device-turn-your-raspberry-pi-into-a-multitool/#balenaSound-pihole

But i keep getting the following error:
sha256:82f7bfb64202be529c9a4b36c3be0ae32ca6cd7180a25ec7cfb4bf2b31ed67be'
certbot standard_init_linux.go:207: exec user process caused "exec format error"
certbot standard_init_linux.go:207: exec user process caused "exec format error"
certbot standard_init_linux.go:207: exec user process caused "exec format error"
Restarting service 'adguard sha256:219fa21da52af6f222166403205943e97e208b261687b8833da621d771e3f10f'
adguard standard_init_linux.go:207: exec user process caused "exec format error"
adguard standard_init_linux.go:207: exec user process caused "exec format error"
adguard standard_init_linux.go:207: exec user process caused "exec format error"

Any idea how to fix this? I tried using different port numbers instead of 80:80
I used 3000:80, still nothing

I am trying to run balena sound and balena adguard together.

Thank you,

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

docker-compose
docker-compose.yml
  • adguard/adguardhome v0.107.7
  • balenablocks/hostname latest
github-actions
.github/workflows/balena.yml
  • actions/checkout v3
  • balena-io/deploy-to-balena-action v0.11.0

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.