diff --git a/README.md b/README.md index e3f3b257..505edf19 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,186 @@ -Pi-hole Admin Dashboard -============ -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/938b4d9e61b7487da77cf63ba05c683d)](https://www.codacy.com/app/Pi-hole/AdminLTE?utm_source=github.com&utm_medium=referral&utm_content=pi-hole/AdminLTE&utm_campaign=badger) -[![Join the chat at https://gitter.im/pi-hole/AdminLTE](https://badges.gitter.im/pi-hole/AdminLTE.svg)](https://gitter.im/pi-hole/AdminLTE?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +

+Pi-hole

+Network-wide ad blocking via your own Linux hardware
+
+Pi-hole Web interface
+

-[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif "AdminLTE Presentation")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate") +Pi-hole[®](https://pi-hole.net/trademark-rules-and-brand-guidelines/)'s Web interface (based off of [AdminLTE](https://almsaeedstudio.com)) provides a central location to manage your Pi-hole and review the statistics generated by FTLDNS[™](https://pi-hole.net/trademark-rules-and-brand-guidelines/). -Using **[AdminLTE](https://almsaeedstudio.com)**, this project will create a Web interface for the ad-blocking Pi-hole: **a black hole for Internet advertisements**. +- **Easy-to-interpret**: simple graphs and beautiful colors make Pi-hole's stats easy to understand +- **Responsive**: looks great on desktop, tablets, and mobile devices +- **Useful**: control and configure your Pi-hole with our settings +- **Insightful**: use the query log, audit log, or long-term stats to gain insight into your networks activity -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. +--- + +
-![Pi-hole Web interface](http://i.imgur.com/EgGZXbT.png) +# Installation + +The Web interface is enabled by default when you install Pi-hole. + +## Post-installation: access the Web interface and gain insight into your network's activity +There are several ways to [access the dashboard](https://discourse.pi-hole.net/t/how-do-i-access-pi-holes-dashboard-admin-interface/3168): + +1. `http:///admin/` +2. `http:/pi.hole/admin/` (when using Pi-hole as your DNS server) +3. `http://pi.hole/` (when using Pi-hole as your DNS server) + +Once logged in (forgot your password?), you can view your network stats to see things like: + +- the domains being queried on your network +- the time the queries were initiated +- the amount of domains that were blocked +- the upstream server queries were sent to +- the type of queries (`A`, `AAAA`, `CNAME`, `SRV`, `TXT`, etc.) +--- + +## Pi-hole is free, but powered by your support +There are many reoccurring costs involved with maintaining free, open source, and privacy respecting software; expenses which [our volunteer developers](https://github.com/orgs/pi-hole/people) pitch in to cover out-of-pocket. This is just one example of how strongly we feel about our software, as well as the importance of keeping it maintained. + +Make no mistake: **your support is absolutely vital to help keep us innovating!** + +### Donations +Sending a donation using our links below is **extremely helpful** in offsetting a portion of our monthly expenses: + +- PP Donate via PayPal
+- BTC [Bitcoin](https://commerce.coinbase.com/checkout/fb7facaf-bebd-46be-bb77-b358f4546763): 1GKnevUnVaQM2pQieMyeHkpr8DXfkpfAtL
+- BTC [Bitcoin Cash](https://commerce.coinbase.com/checkout/fb7facaf-bebd-46be-bb77-b358f4546763): qqh25hlmqaj99xraw00e47xmf8sysnyxhyww2d7dnh
+- BTC [Ethereum](https://commerce.coinbase.com/checkout/fb7facaf-bebd-46be-bb77-b358f4546763): 0xF00aF43d2431BAD585056492b310e48eC40D87e8 + +### Alternative support +If you'd rather not [donate](https://pi-hole.net/donate/) (_which is okay!_), there are other ways you can help support us: + +- [Digital Ocean](http://www.digitalocean.com/?refcode=344d234950e1) _affiliate link_ +- [UNIXstickers.com](http://unixstickers.refr.cc/jacobs) _save $5 when you spend $9 using our affiliate link_ +- [Pi-hole Swag Store](https://pi-hole.net/shop/) _affiliate link_ +- [Amazon](http://www.amazon.com/exec/obidos/redirect-home/pihole09-20) _affiliate link_ +- [Ho-ost](https://clients.ho-ost.com/aff.php?aff=19) _save 50% with our affiliate link_ +- [DNS Made Easy](https://cp.dnsmadeeasy.com/u/133706) _affiliate link_ +- [Vultr](http://www.vultr.com/?ref=7190426) _affiliate link_ +- Spreading the word about our software, and how you have benefited from it + +### Contributing via GitHub +We welcome _everyone_ to contribute to issue reports, suggest new features, and create pull requests. + +If you have something to add - anything from a typo through to a whole new feature, we're happy to check it out! Just make sure to fill out our template when submitting your request; the questions that it asks will help the volunteers quickly understand what you're aiming to achieve. + +### Presentations about Pi-hole +Word-of-mouth continues to help our project grow immensely, and so we are helping make this easier for people. + +If you are going to be presenting Pi-hole at a conference, meetup or even a school project, [get in touch with us](https://pi-hole.net/2017/05/17/giving-a-presentation-on-pi-hole-contact-us-first-for-some-goodies-and-support/) so we can hook you up with free swag to hand out to your audience! + +----- + +## Getting in touch with us +While we are primarily reachable on our Discourse User Forum, we can also be found on a variety of social media outlets. **Please be sure to check the FAQ's** before starting a new discussion, as we do not have the spare time to reply to every request for assistance. + + + +# Features + +## Mobile friendly interface +

+Mobile friendly +

+ +## Password protection +

+Password protection +

+ +## Detailed graphs and doughnut charts +

+Pie charts +

+ +## Top lists of domains and clients +

+Top domains/top clients +

+ +## A filterable and sortable query log +

+Query log +

+ +## An audit log +

+Pi-hole Web interface +

+ +## Long Term Statistics to view data over user defined time ranges +

+Long-term stats +

+ +## A built-in debugger +

+Debugger +

+ +## Black and white lists +

+Blacklist +

+Whitelist +

+ +## The ability to easily manage and configure Pi-hole features +

+Settings +

+ +## ... and all the main features of the Command Line Interface! +

+Tail the log +

+Query ad lists +

## API -A read-only API can be accessed at `/admin/api.php`. With either no parameters or `api.php?summary` it returns the following JSON: +Full usage available [here](https://discourse.pi-hole.net/t/pi-hole-api/1863). can be accessed at `/admin/api.php`. With either no parameters or `/admin/api.php?summary` it returns the following JSON: ```JSON -{ - "domains_being_blocked": "136,708", - "dns_queries_today": "18,108", - "ads_blocked_today": "14,648", - "ads_percentage_today": "80.9" +{ + "domains_being_blocked":243038, + "dns_queries_today":2385, + "ads_blocked_today":414, + "ads_percentage_today":17.35849, + "unique_domains":429, + "queries_forwarded":1537, + "queries_cached":434, + "clients_ever_seen":5, + "unique_clients":5, + "status":"enabled" } ``` -There are many more parameters, such as `summaryRaw`, `overTimeData10mins`, `topItems`, ` topClients` or `getQuerySources`, `getQueryTypes`, `getForwardDestinations`, and finally `getAllQueries`. -Together with a token it is also possible to enable and disable (also with a set timeout) blocking via the API +[There are many more parameters](https://discourse.pi-hole.net/t/pi-hole-api/1863), such as: -The API returns more information (in a slighly different format if `FTL` is running) - it supports a fall-back to the "old" PHP API if `FTL` is not running. Test the type and/or version of the API by using the parameter `type` and `version`. +- `type & version` +- `summaryRaw` +- `summary` +- `overTimeData10mins` +- `topItems` +- `getQuerySources` +- `getForwardDestinations` +- `getQueryTypes` +- `getAllQueries` +- `enable` +- `disable` +- `recentBlocked` -
-
-We use BrowserStack for multi-platform multi-browser testing. +Together with a token it is also possible to [enable and disable (also with a set timeout) blocking via the API](https://discourse.pi-hole.net/t/is-there-an-api-command-to-disable-ad-blocking/7693). + +The API returns more information (in a slightly different format if `FTL` is running) - it supports a fall-back to the "old" PHP API if `FTL` is not running. Test the type and/or version of the API by using the parameter `type` and `version`.