Pi-Hole/docs
1
0
Fork 0
mirror of https://github.com/pi-hole/docs.git synced 2026-04-02 00:19:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1329 from pi-hole/update/compile

Browse Source 
Update instructions how to compile FTL from source
This commit is contained in:
yubiuser
2026-02-17 20:55:01 +01:00
committed by GitHub
parent 89d58a9c99 aa0bfac6c2
commit 850112ea96
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/ftldns/compile.md
View File

@@ -1,4 +1,4 @@
We pre-compile *FTL*DNS for you to save you the trouble of compiling anything yourself. However, sometimes you may want to make your own modifications. To test them, you have to compile *FTL*DNS from source. Luckily, you don't have to be a programmer to build *FTL*DNS from source and install it on your system; you only have to know the basics we provide in here. With just a few commands, you can build *FTL*DNS from source like a pro. We pre-compile FTL for you to save you the trouble of compiling anything yourself. However, sometimes you may want to make your own modifications. To test them, you have to compile FTL from source. Luckily, you don't have to be a programmer to build FTL from source and install it on your system; you only have to know the basics we provide in here. With just a few commands, you can build FTL from source like a pro.
# Install native build environment # Install native build environment
@@ -23,7 +23,7 @@ sudo dnf install git wget ca-certificates gcc gmp-devel gmp-static m4 cmake libi
## Compile `libnettle` from source ## Compile `libnettle` from source
*FTL*DNS uses a cryptographic library (`libnettle`) for handling DNSSEC signatures. FTL uses a cryptographic library (`libnettle`) for handling DNSSEC signatures.
Compile and install a recent version using: Compile and install a recent version using:
```bash ```bash
@@ -39,25 +39,26 @@ Since Ubuntu 20.04, you need to specify the library directory explicitly. Otherw
## Compile `libmbedtls` from source ## Compile `libmbedtls` from source
*FTL*DNS uses another cryptographic library (`libmbedtls`) containing cryptographic primitives, X.509 certificate manipulation and the SSL/TLS and DTLS protocols used for serving the web interface and the API over HTTPS. FTL uses another cryptographic library (`libmbedtls`) containing cryptographic primitives, X.509 certificate manipulation and the SSL/TLS and DTLS protocols used for serving the web interface and the API over HTTPS.
Compile and install a recent version using: Compile and install a recent version using:
```bash ```bash
wget https://github.com/Mbed-TLS/mbedtls/archive/refs/tags/v3.6.4.tar.gz -O mbedtls-3.6.4.tar.gz wget https://github.com/Mbed-TLS/mbedtls/releases/download/mbedtls-4.0.0/mbedtls-4.0.0.tar.bz2 -O mbedtls-4.0.0.tar.bz2
tar -xzf mbedtls-3.6.4.tar.gz tar -xjf mbedtls-4.0.0.tar.bz2
cd mbedtls-3.6.4 cd mbedtls-4.0.0
sed -i '/#define MBEDTLS_THREADING_C/s*^//**g' include/mbedtls/mbedtls_config.h sed -i '/#define MBEDTLS_THREADING_C/s*^//**g' include/mbedtls/mbedtls_config.h
sed -i '/#define MBEDTLS_THREADING_PTHREAD/s*^//**g' include/mbedtls/mbedtls_config.h sed -i '/#define MBEDTLS_THREADING_PTHREAD/s*^//**g' include/mbedtls/mbedtls_config.h
make -j $(nproc) cmake -S . -B build -DCMAKE_C_FLAGS="-fomit-frame-pointer"
sudo make install cmake --build build -j $(nproc)
sudo cmake --install build
``` ```
The `sed` commands are necessary to enable multi-threading support in `libmbedtls` as there is no `configure` script to do this for us (see also [here](https://github.com/Mbed-TLS/mbedtls#configuration)). The `sed` commands are necessary to enable multi-threading support in `libmbedtls` as there is no `configure` script to do this for us (see also [here](https://github.com/Mbed-TLS/mbedtls#configuration)).
## Get the source ## Get the source
Now, clone the *FTL*DNS repo (or your own fork) to get the source code of *FTL*DNS: Now, clone the FTL repo (or your own fork) to get the source code of FTL:
```bash ```bash
git clone https://github.com/pi-hole/FTL.git && cd FTL git clone https://github.com/pi-hole/FTL.git && cd FTL
@@ -71,7 +72,7 @@ git checkout development
## Compile the source ## Compile the source
*FTL*DNS can now be compiled using either the build script FTL can now be compiled using either the build script
```bash ```bash
./build.sh ./build.sh
@@ -101,7 +102,7 @@ or
cd cmake && sudo make install cd cmake && sudo make install
``` ```
Finally, restart *FTL*DNS to use the new binary: Finally, restart FTL to use the new binary:
```bash ```bash
sudo service pihole-FTL restart sudo service pihole-FTL restart