JordanEJ / OpenWebGuard

An opensource esp8266/32 website blocker and adblocker with advanced options.

OpenWebGuard

An awesome opensource ESP8266/ESP32 dns ad/tracker/website blocker!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Planned Features
5. Contributing
6. License

About The Project

OpenWebGuard is about safe internet usage and privacy. By default it blocks most ads and trackers.

As this project is only in the early stages there is plenty more to come. Click here to see all of the awsome planned features 😎 .

(back to top)

Getting Started

Instructions will come soon

Prerequisites

To be added

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Add your WiFi Credentials to OpenWebGuard.ino where it says const char* ssid = "Your_SSID"; and const char* ssid = "Your_SSID";

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Planned Features

• Get a basic DNS working
• Create a lightweight HTML Dashboard
  • Online update
  • Select timezone
  • Import/backup host lists and times
  • Gauges with stats
• Web flasher
• Automatic OTA updates
• Custom block lists
• Backup/restore presets
• use blocklists from a URL
• Static IP
• Use a url instead of a IP for web interface (e.g esp8266.local)
• Get current time from internet

(back to top)

Contributing

Please feel free to help contribute to this project. Simply create a fork of this repository and make your changes then create a pull request. If your pull request is accepted it will be merged with the main branch.

If you don't have much experience with code but still want a certian feature or you have found a mistake somewhere please open an issue and tag it with "bug" or "enhancement" depending on the situation.

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)