web/README.md

Pi-hole Admin Dashboard

Using AdminLTE, this project will create a Web interface for the ad-blocking Pi-hole: a black hole for Internet advertisements.

From this interface, you will be able to see stats on how well your Pi-hole is performing. You will also be able to update the lists used to block ads.

API

A basic read-only API can be accessed at /admin/api.php. It returns the following JSON:

{
	"domains_being_blocked": "136708",
	"dns_queries_today": "18108",
	"ads_blocked_today": "14648",
	"ads_percentage_today": 80.892423238348
}

Contributing

If you would like to add to the project, please make sure to follow these guidelines:

1. Branch off of devel into your own feature branch (ex. feature).
2. When you are finished, make a pull request to merge your feature branch into devel.

Keep these things in mind:

• Use 4 spaces instead of tabs
• Commit Unix line endings
• If you want, try to keep to the theme of black holes/gravity. This can add some fun to your submission.