Giter Club home page Giter Club logo

go-hole's Introduction

Go-hole

Go Report Card

Minimalistic DNS server which serves as an upstream proxy and ad blocker. Written in Go, inspired by Pi-hole®.

Features

  • Minimalistic DNS server, written in Golang, optimized for high performance
  • Blacklist DNS names via user-specific source lists
  • Whitelist DNS names that are actually blacklisted
  • Multiple user-settable upstream DNS servers
  • Caching of upstream query results
  • Local name resolution
  • Pre-built, minimalistic Docker image

How it works

Go-hole serves as DNS server on your (home) network. Instead of having your clients sending DNS queries directly to the internet or to your router, they are resolved by your local Go-hole instance. Go-hole sends these queries to one or more upstream DNS servers and caches the upstream query results for maximum performance.

Incoming queries from your clients are checked against a list of unwanted domain names ("blacklist"), such as well-known ad serving domains and trackers. If a requested name matches a name on the blacklist, Go-hole responds with error code NXDOMAIN (non-existing domain). This leads to clients not being able to load ads and tracker codes. In case you want to access a blacklisted domain, you can easily add it to a whitelist.

As an additional feature, you can set a list of custom hostnames/domain names to be resolved to specific IP addresses. This is useful for accessing services on your local network by name instead of their IP addresses.

Usage

  1. Create a config.yaml file. Use the config.yaml in this repository as a template and customize is according to your needs.
  2. Run Go-hole using Docker and mount your previously created config.yaml:
    docker run \
        --rm \
        --mount type=bind,source=${PWD}/config.yaml,target=/app/config.yaml \
        -p 53:53/udp \
        ghcr.io/virtualzone/go-hole:latest
  3. Set Go-hole as your network's DNS server (i.e. in your DHCP server's configuration).

go-hole's People

Contributors

dependabot[bot] avatar virtualzone avatar

Stargazers

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

Watchers

 avatar

go-hole's Issues

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.