The Pi-hole FTL engine
Go to file
Adam Warner 47128aafd1
Merge pull request #1523 from pi-hole/development
v5.20.1
2023-01-15 19:57:00 +00: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 Merge pull request #1523 from pi-hole/development 2023-01-15 19:57:00 +00:00
patch Re-add /*** Pi-hole modification ***/ comments 2022-11-26 18:13:33 +01:00
src Remove gray color in help output 2023-01-08 22:20:36 +01:00
test Adds colors (if available) to verbose version output and completely revamp the help function 2022-12-09 10:42:20 +01: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 facility to embedd LUA scripts into FTL and run them during luainit 2022-11-20 12:57:39 +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.88 2022-12-21 20:38:57 +01: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 Ensure compiled scripts are updated if the scripts themselves are updated 2022-11-25 12:07:38 +01: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.