• Stars
    star
    403
  • Rank 107,140 (Top 3 %)
  • Language
    Shell
  • Created over 3 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Pi-hole/Unbound Raspbian APK Installer for Android 5.0+ devices (requires root)

Pi-hole for Android APK Installer

IMG_2229

Note: There is no endorsement or partnership between this page and Pi-holeΒ© LLC. They deserve your support if you find this useful.

Pi-hole is a network-level advertisement and Internet tracker blocking application for Linux which acts as a DNS sinkhole intended for use on a private network. It is designed for low-power embedded devices with network capability, focusing on the Raspberry Pi as its 'reference' hardware platform.

Pi-hole for Android is a Raspbian disk image tuned to work with the Pi-hole installer on Pi Deploy (a fork of Linux Deploy). It can be used on any rooted Android device with an ARMv7 or newer CPU running Android 5.0 (Lolipop) or newer. Form factor is not important; it could be a phone, tablet, HDMI stick or any device running Android. For very old devices running Android 4.x, see the Legacy branch

Requirements:

  • Android device that has been rooted

Note to users of previous builds:

  • Uninstall any previous versions of Linux Deploy or Pi Deploy and reboot your device.
  • Failure to heed this advice will cause issues!

Installation:

  • Install the latest Pi Deploy APK
  • Tap the main menu (Three dots at the top right of screen)
  • Tap Install
  • In a few minutes, the Raspbian Pi-hole Image will be downloaded and installed on your device.
  • When deployment is complete, tap [ β–· START ] to launch the instance.
  • The instance will provide you with a password to login to Pi-hole webadmin or via SSH/RDP (Username: android, see screenshot below)
  • Note: The password appears only once when the image is deployed, make sure you record this information.
  • Hint: The password text can be highlighted and copied to your clipboard for easier management.

INSTALLATION COMPLETE    ·    Pi-Hole is running on your Android Device


The Android device's IP is shown at the top of the Linux Deploy main window. You can interact with Pi-hole in several ways, the examples below use IP 10.73.0.31

  • From a Windows desktop, connect via RDP -> mstsc.exe /v:10.73.0.31

  • From a computer running Linux, connect via SSH -> ssh [email protected]

  • Pi-hole administration is accessible from any browser on your network -> http://10.73.0.31/admin

  • If your Android device has a display, you can RDP into the Pi-hole instance (as localhost) by installing the Microsoft Remote Desktop client.

image

image

Screenshot_20221020-013907_Bromite

Pi-hole for Android wiki topics:

Additional Info:

RDP Sessions launch the Openbox window manager with QTerminal in fullscreen mode. To open a new tab hit [Ctrl-Shift-T] and to un-hide the menubar hit [Ctrl-Shift-M]

You can restart (or "bounce") the Pi-hole instance in Pi Deploy by pressing [ β–  STOP ] and waiting a few seconds for the instance to indicate all services are stopped. Restart the instance by pressing [ β–Έ START ]

When a Pi-hole instance starts up, the default setting is to let it automagically configure networking. If you change networks on the Android device simply restart the instance for Pi-hole to pick up the new settings.

Alternatively, set a static assignment by commenting-out two lines in /etc/init.d/android-init (You will see which ones when you open the file in an editor.) After the lines are commented out with a hash "#" you can manually add your IP, subnet and interface name to /etc/pihole/setupVars.conf

Added latest release of Unbound 1.17 to provide encrypted DNS by default; no addional configuration is necessary but you may customize to preference.

The Pi-hole instance on Android otherwise behaves like it is running on a 'real' Raspberry-Pi or a standard PC. Consult the extensive documentation online to learn how to fully leverage Pi-hole's functionality.

Adjust QT display scaling: ~/startwm.sh

Change the font size in QTerminal: ~/.config/qterminal.org/qterminal.ini

If your Android device has a battery and was unused for months or years, replace its battery. Old, worn, or abused Li-ion batteries can fail when pushed back into service. Failure appears as a bulge in the battery, or worse a thermal event. A good battery provides UPS protection for your newly-provisioned Pi-hole.