https://github.com/pi-hole/FTL

The Pi-hole FTL engine
https://github.com/pi-hole/FTL

api c database dns ftl pi-hole pi-hole-ftl

Last synced: about 1 month ago
JSON representation

The Pi-hole FTL engine

• Host: GitHub
• URL: https://github.com/pi-hole/FTL
• Owner: pi-hole
• License: other
• Created: 2017-02-02T10:52:55.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T17:41:31.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:25:40.722Z (about 1 month ago)
• Topics: api, c, database, dns, ftl, pi-hole, pi-hole-ftl
• Language: C
• Homepage: https://pi-hole.net
• Size: 36.9 MB
• Stars: 1,374
• Watchers: 62
• Forks: 196
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - FTL - hole FTL engine | pi-hole | 1388 | (C)
• stars - FTL - hole FTL engine | pi-hole | 1388 | (C)

README

        


  

    

      

      

      

    

  

  


  Network-wide ad blocking via your own Linux hardware



  

    

      

      

      

    

  

  




FTLDNS (`pihole-FTL`) provides an interactive API and also generates statistics for Pi-hole[®](https://pi-hole.net/trademark-rules-and-brand-guidelines/)'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](https://discourse.pi-hole.net/t/hardware-software-requirements/273) 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 *FTL*DNS documentation can be found [here](https://docs.pi-hole.net/ftldns/).

## 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.