adam/mc-webui
1
0
Fork 0
mirror of https://github.com/MarekWo/mc-webui.git synced 2026-08-07 09:12:57 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(android): ship the Android companion app with an install guide

Browse Source 
A thin WebView wrapper that opens a user's own mc-webui instance full
screen, without the browser address bar. It asks once for the server
address and remembers it; all logic stays on the server.

- android/mc-webui-wrapper.apk (1.0, it.wojtaszek.mc.wrapper, minSdk 21)
- docs/android-app.md: download + checksum, "unknown sources" permission,
  the Play Protect notice, first connection, and the limitations that come
  with a WebView (no notifications, no QR camera, no file downloads)
- README, user guide and whatsnew entries, incl. an app-vs-PWA comparison
- *.apk marked binary so the text=auto rule can never touch it

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
MarekWo
2026-07-28 20:55:04 +02:00
parent 0c10640e28
commit f71cac8b2e
7 changed files with 222 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17
View File
@@ -38,6 +38,7 @@ A lightweight web interface providing browser-based access to MeshCore mesh netw
- **DM delivery tracking** - ACK-based delivery confirmation with SNR, route, and hop count details
- **Multi-device support** - Database file named after device public key for easy multi-device setups
- **PWA support** - Browser notifications and installable app (experimental)
- **Android app** - Optional companion app that opens your instance full screen, without the browser address bar
- **Full offline support** - Works without internet (local Bootstrap, icons, emoji picker)
For detailed feature documentation, see the [User Guide](docs/user-guide.md).
@@ -285,6 +286,21 @@ For complete usage instructions, see the [User Guide](docs/user-guide.md).
---
## Android App
<table>
<tr>
<td width="200" align="center"><a href="images/android-wrapper-setup.jpg"><img src="images/android-wrapper-setup.jpg" width="180"></a></td>
<td>
A companion app that opens your own instance full screen — no address bar, its own icon in the app drawer. Everything still runs on your server; the app only displays it.<br><br>
It is not distributed through Google Play. Download <a href="android/mc-webui-wrapper.apk"><code>android/mc-webui-wrapper.apk</code></a>, install it on the phone, and enter the address of your instance once (e.g. <code>http://192.168.1.100:5000</code>).<br><br>
Full instructions — including the "unknown sources" and Play Protect warnings, and what the app can and cannot do — are in the <a href="docs/android-app.md">Android App guide</a>.
</td>
</tr>
</table>
---
## Updating
### Docker Hub installation
@@ -444,6 +460,7 @@ sudo ~/mc-webui/scripts/updater/install.sh --uninstall
| Document | Description |
|----------|-------------|
| [User Guide](docs/user-guide.md) | Complete feature documentation |
| [Android App](docs/android-app.md) | Installing the Android companion app and connecting it to your instance |
| [Architecture](docs/architecture.md) | Technical details, API reference |
| [Troubleshooting](docs/troubleshooting.md) | Common issues and solutions |
| [Docker Installation](docs/docker-install.md) | How to install Docker on Debian/Ubuntu |