search

joshspicer / pihole-mobile-app

iOS and Android (Xamarin Forms) app to manage your local Pi-hole
https://apps.apple.com/us/app/pi-contrhole/id1507963158
Other
27 stars 3 forks source link
android app forms ios iphone pi-hole pihole xamarin xamarin-forms

readme

pihole-dashboard

Build status

A simple Xamarin Forms Shell app to manage your local Pi-hole instance.

The idea of this app is to provide "quick toggles" and display information that would be useful at a glance. My goal is not to reach parity with the (awesome) web app that already exists. Use cases include:

  1. Allow less technically inclined/interested people to disable your home's pi-hole temporarily.
  2. Ensure your pi-hole instance is up and running.
  3. Check that a given device is routing through pi-hole.

Feel free to open an issue for any ideas/concerns, after checking out the feature road map. Pull requests are welcomed and encouraged!

Version 1.4

Version 1.0-1.3

Usage

App Store (iPhone)

This app is available on the iOS app store under the name Pi ContrHOLE.

Build yourself (iPhone/Android)

Download, Visual Studio 2019 (Mac/Windows), open the .sln file, and build for the appropriate device (ios/android).

Although this app is technically cross platform, I haven't been actively testing the Android version (and as such there might be some minor issues with it).

Note

You will need an API key for anything in that requires authorization. For more details check here.

The Pi-Hole web UI's generated API key can be found here: Settings > API/Web Interface > Show API Token. The app also lets you scan the QR code that pi-hole generates.

One final place you can find the key is as the WEBPASSWORD found under /etc/pihole/setupVars.conf

The API utilized is outlined here.

Development

Please feel free to push feature/bug PRs! I'll merge it into dev branch, which automatically builds and releases a TestFlight build via AppCenter. If you'd like to join the experimental Testflight channel, contact me!

Once we agree everything is working on iOS, i'll merge to master, and a new App Store version will be released.

License

Creative Commons License
This work is licensed under a Creative Commons Attribution 3.0 Unported License.

This work is licensed under the Creative Commons Attribution 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by/3.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.