The Pi-hole FTL engine
Go to file
Christian König 027f9496ce
Update README.MD
Signed-off-by: Christian König <ckoenig@posteo.de>
2022-11-06 15:53:19 +01:00
.devcontainer Add basic devcontainer.json based on ftl-build for x86_64 arch, with a few helpful extensions. 2022-07-25 18:05:01 +01:00
.github Bump actions/checkout from 3.0.2 to 3.1.0 2022-10-15 16:03:23 +00:00
src Fix comment 2022-10-11 00:54:01 -03:00
test Tests: Domain auditing, there are some non-approved domains after the tests 2022-10-01 13:47:27 +02:00
tools Fix outdated link to Wireshark manufacturer database 2022-05-21 22:55:33 +02:00
.codespellignore Fix some spellings, ignore others 2022-04-22 18:26:31 +01:00
.gitignore Add basic devcontainer.json based on ftl-build for x86_64 arch, with a few helpful extensions. 2022-07-25 18:05:01 +01:00
.gitmodules Removed bats submodules 2019-06-08 18:35:10 +02:00
.pullapprove.yml Add PullApprove settings file (copied from core repo) (#23) 2017-05-01 14:47:46 +02:00
CMakeLists.txt Update embedded dnsmasq to v2.87 2022-09-26 19:15:48 +02:00
LICENSE Improve formating 2017-06-03 15:05:41 +02:00
README.md Update README.MD 2022-11-06 15:53:19 +01:00
build.sh Replace nonstandard `which` 2022-09-12 22:27:28 +00:00
deploy.sh Only try to create the subdir if does not already exist 2022-08-02 00:10:26 +02:00

README.md

Pi-hole website
Network-wide ad blocking via your own Linux hardware

FTLDNS

FTLDNS (pihole-FTL) provides an interactive API and also generates statistics for Pi-hole®'s Web interface.

  • Fast: stats are read directly from memory by coupling our codebase closely with dnsmasq
  • Versatile: upstream changes to dnsmasq can quickly be merged in without much conflict
  • Lightweight: runs smoothly with minimal hardware and software requirements such as Raspberry Pi Zero
  • Interactive: our API can be used to interface with your projects
  • Insightful: stats normally reserved inside of dnsmasq are made available so you can see what's really happening on your network

Official documentation

The official FTLDNS documentation can be found here.

Installation

FTLDNS (pihole-FTL) is automatically installed when installing Pi-hole.

IMPORTANT

FTLDNS will disable any existing installations of dnsmasq. This is because FTLDNS is dnsmasq + Pi-hole's code, so both cannot run simultaneously.