{"id":15148343,"url":"https://github.com/desktopecho/pi-hole-for-android","last_synced_at":"2025-04-12T02:59:52.256Z","repository":{"id":41233824,"uuid":"404470486","full_name":"DesktopECHO/Pi-hole-for-Android","owner":"DesktopECHO","description":"Pi-hole/Unbound Raspbian APK Installer for Android 5.0+ devices (requires root)","archived":false,"fork":false,"pushed_at":"2025-03-03T17:06:48.000Z","size":74610,"stargazers_count":482,"open_issues_count":0,"forks_count":39,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-12T02:59:46.071Z","etag":null,"topics":["adb","adblocker","android","pi-hole","pihole"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DesktopECHO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-08T19:27:14.000Z","updated_at":"2025-04-11T21:36:44.000Z","dependencies_parsed_at":"2024-08-23T09:59:52.785Z","dependency_job_id":"4dfe14e8-5384-4940-a6ad-9f11028bedda","html_url":"https://github.com/DesktopECHO/Pi-hole-for-Android","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FPi-hole-for-Android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FPi-hole-for-Android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FPi-hole-for-Android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DesktopECHO%2FPi-hole-for-Android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DesktopECHO","download_url":"https://codeload.github.com/DesktopECHO/Pi-hole-for-Android/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248510008,"owners_count":21116131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adb","adblocker","android","pi-hole","pihole"],"created_at":"2024-09-26T13:03:11.974Z","updated_at":"2025-04-12T02:59:52.191Z","avatar_url":"https://github.com/DesktopECHO.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pi-hole for Android APK Installer\n\n[![Pi-hole for Android](https://user-images.githubusercontent.com/33142753/133272103-28c6eba3-d1f7-4e29-9c5b-7d96d9f94e9e.jpg)](https://www.youtube.com/watch?v=sdDkKvaRvOs)\n\n[Pi-hole©](https://pi-hole.net/) 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.\n\nPi-hole for Android is a Debian 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](https://github.com/DesktopECHO/Pi-hole-for-Android/tree/legacy)\n\n\n### What's New (March 2025)\n - **Update for Pi-hole v6 compatibility**\n - Removed lighttpd (not used in v6)\n - Fixed missing PulseAudio volume control in `pideploy-gui-install` XRDP session.\n - Fixed `pideploy-nextcloud-install` to move Pi-hole v6 webserver ports. \n - Pi Deploy image is **64-bit** by default.\n - For **32-bit** devices, configure Pi Deploy to download the ARMv7 image:  Tap **Properties** and change the end of the **Source Path** URL from `/raspbian.tgz` to `/raspbian32.tgz`\n \n### Note to users running previous version:\n- Installer is unchanged from v3.1.4, **no need to uninstall/reinstall the APK.** \n- Login to your existing deployment and run `sudo unchroot uname -m`.  If your device returns `armv7`or `armv8`, your Android build is 32-bit and you **must** change the **Source Path** URL to `/raspbian32.tgz`  \n- If required, use Pi-hole Teleporter to back-up your existing configuration.\n\n### Requirements:\n\n- Android device that has been rooted\n\n### Note to users running previous version:\n- The APK installer is unchanged (no need to re-install the Pi Deploy APK)\n- If required, use Pi-hole Teleporter to back-up your existing configuration.\n- Login to your existing deployment and run `sudo unchroot uname -m`.  If your device returns `armv7`or `armv8` your device is 32 bit and you need to change the **Source Path** URL to `/raspbian32.tgz` \n\n## Install \n### Download the latest [Pi Deploy APK](https://github.com/DesktopECHO/Pi-hole-for-Android/releases/latest/download/pideploy.apk) and open the app.\n\n- Tap **Allow** if asked for permission to access files or run as root.  \n\n- Tap **More Options** (**Three dots** at the top right of screen)\n    ![image](https://github.com/DesktopECHO/Pi-hole-for-Android/assets/33142753/b8cbe9e3-f47a-4e3b-a155-b6b0aa3a5161\")\n\n- Tap **New Deployment**:\n    ![image](https://github.com/DesktopECHO/Pi-hole-for-Android/assets/33142753/a438ee12-b849-4c04-8be1-e5f61f4ba659)\n\n- In a few minutes, the [Raspbian Pi-hole Image](https://github.com/DesktopECHO/Pi-hole-for-Android/releases/latest/download/raspbian.tgz) will be downloaded and installed on your device.\n- When deployment is complete, tap **[  ▷ START ]**  to launch the instance.\n- The instance will provide you with a password to login to Pi-hole webadmin or via SSH/RDP (Username: _android_, see screenshot below)\n- **Note**: The password appears only once when the image is deployed, make sure you record this information.  You can also copy the password text to your clipboard for easier management. \n\n-----------------------------------------------------------\n### **INSTALL COMPLETE     ·     Your Android device is a Debian server running Pi-Hole!**\n\n-----------------------------------------------------------\nThe Android device's IP is shown at the top of the Pi Deploy main window.  You can interact with Pi-hole in several ways, the examples below use IP **_10.73.0.31_** \n\n - Connect via RDP in Windows using **```mstsc.exe /v:10.73.0.31```** or in Linux using **```xfreerdp /v:10.73.0.31```** \n\n - Connect via SSH **-\u003e** **```ssh android@10.73.0.31```**\n\n - Pi-hole administration is accessible from any browser on your network **-\u003e** **```http://10.73.0.31/admin```**\n\n - If your Android device has a display, you can RDP into the Pi-hole instance (as localhost) by installing the [Microsoft Remote Desktop](https://play.google.com/store/apps/details?id=com.microsoft.rdc.androidx) client.\n\n![image](https://user-images.githubusercontent.com/33142753/196851777-e46b145f-4c99-4b6f-9add-ed2f009dae4b.png)\n\n![image](https://user-images.githubusercontent.com/33142753/196856874-72c307e3-2227-4ef1-a7b5-401e745f918f.png)\n\n![Screenshot_20221020-013907_Bromite](https://user-images.githubusercontent.com/33142753/196860440-1723d8c2-09b0-460b-901e-260b5485d554.png)\n\n**Pi-hole for Android wiki topics:**\n\n- [Pi/Linux Deploy - Trouble finding disk image or install location](https://github.com/DesktopECHO/Pi-hole-for-Android/wiki/Trouble-finding-path-where-Pi%E2%80%90hole-image-is-downloaded,-or-errors-are-reported-during-creation-of-Pi%E2%80%90hole-disk-image.)\n\n**Additional Info:**\n\nRDP 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]**\n\nYou can stop the Pi-hole instance by pressing **[ ■ STOP ]** and waiting a few seconds for all services to stop.  Sart the instance by pressing **[ ▸ START ]**\n\nWhen a Pi-hole instance starts up, the default configuration is set to automagically configure networking.  If you change networks on the Android device simply restart the instance for Pi-hole to pick up the new settings.\n\nAlternatively, set a static assignment by commenting-out two lines in ```etc/init.d/android-raspbian```.  After the lines are commented out with a hash \"#\" you can manually set your IP, subnet and interface name in ```/etc/pihole/setupVars.conf```\n\n![image](https://github.com/DesktopECHO/Pi-hole-for-Android/assets/33142753/8781dc01-ebe2-4ffc-bdec-82ca62d3cc97)\n\nAdded latest release of [Unbound 1.17](https://www.nlnetlabs.nl/projects/unbound/about) to provide encrypted DNS by default; no addional configuration is necessary but you may customize to preference.\n\nThe 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.\n\nAdjust QT display scaling: ```~/startwm.sh``` \n\nChange the font size in QTerminal: ```~/.config/qterminal.org/qterminal.ini```\n\n**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_**](https://www.urbandictionary.com/define.php?term=unexpected+thermal+event).  A good battery provides [UPS](https://en.wikipedia.org/wiki/Uninterruptible_power_supply) protection for your newly-provisioned Pi-hole.\n\n**Note:** There is no endorsement or partnership between this page and [Pi-hole© LLC](https://pi-hole.net/). They deserve [your support](https://pi-hole.net/donate/) if you find this useful.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesktopecho%2Fpi-hole-for-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdesktopecho%2Fpi-hole-for-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesktopecho%2Fpi-hole-for-android/lists"}