README.md

February 21, 2025 · View on GitHub

DroidHole is an unnoficial Pi-hole® client developed with Flutter.


⚠️ WARNING ⚠️
This application is DEPRECATED and it won't receive more updates.
This application is not compatible with Pi-hole v6. For now I don't have planned to update this app or to release a new app with compatibility with v6. If that changes in the future, it will update this readme.



Main features

▶ Manage your Pi-hole® server on an easy way.

▶ Enable and disable the server with only one button.

▶ Beautiful charts with all the statistics you need to see.

▶ Add multiple servers to the app, and manage all of them from here.

▶ Explore the query logs list and see the log details.

▶ Manage your domain lists. Add and remove domains to the whitelist or blacklist.

▶ Material You interface with dynamic theming (only Android 12+)

Requires Android 8.0+

Disclaimer

This is an unofficial application. The Pi-hole team and the development of the Pi-hole software is not related in any way with this application.

On this repository you can find some recommended lists. Thanks to JuanRodenas.

Donations

If you like the project and you want to contribute with the development, you can become a sponsor on GitHub, or you can donate using PayPal.

Donate with PayPal

Prepare the development environment

  1. Clone the repository
  2. Run flutter pub get
  3. Clone the .env.sample file and name it .env
  4. On the SENTRY_DSN variable assign it's value
  5. Inside the android folder, clone the key.properties.sample file and name it key.properties
  6. Open the file and fill the variables with the corresponding values
  7. Store your keystore.jks file inside android/app

Compile the production build

Android
  1. Run flutter clean
  2. Run flutter pub get
  3. Run flutter build apk --release to build the .apk file
  4. Run flutter build appbundle --release to build the .aab file
macOS
  1. Run flutter clean
  2. Run flutter pub get
  3. Run flutter build macos --release to build the .app file
Linux
  1. Run flutter clean
  2. Run flutter pub get
  3. Run flutter build linux --release to build the Linux executable
  4. If you want to build also the .deb file do this: 4.1. Run dart pub global activate flutter_to_debian to install the utility that will build the .deb file 4.2. Run flutter_to_debian
Windows
  1. Run flutter clean
  2. Run flutter pub get
  3. Run flutter build windows --release to build the Windows executable
  4. Install the InnoSetup software you don't have it
  5. Run iscc /Q windows/innosetup_installer_builder.iss to generate the Windows installer

Third party libraries


Created by JGeek00