Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dd056c8027 | ||
|
|
16086a593f | ||
|
|
c683f135e3 | ||
|
|
1585d9ee07 | ||
|
|
149d675910 | ||
|
|
0609c73d35 | ||
|
|
79fd148511 | ||
|
|
147cec7c6b | ||
|
|
67968654cb | ||
|
|
fc1cf589a7 | ||
|
|
e2d9810b34 |
20
.github/workflows/android.yml
vendored
20
.github/workflows/android.yml
vendored
@ -8,15 +8,6 @@ on:
|
||||
- "v*"
|
||||
pull_request:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
publish_release:
|
||||
description: "Create or update a GitHub Release"
|
||||
required: true
|
||||
default: "false"
|
||||
type: choice
|
||||
options:
|
||||
- "false"
|
||||
- "true"
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
@ -25,7 +16,7 @@ jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
PUBLISH_RELEASE: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') || inputs.publish_release == 'true' }}
|
||||
PUBLISH_RELEASE: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') }}
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
@ -139,15 +130,7 @@ jobs:
|
||||
env:
|
||||
GH_TOKEN: ${{ github.token }}
|
||||
run: |
|
||||
if [[ "${GITHUB_REF}" == refs/tags/v* ]]; then
|
||||
TAG="${GITHUB_REF_NAME}"
|
||||
else
|
||||
TAG="v${VERSION_NAME}"
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git tag -f "${TAG}"
|
||||
git push -f origin "${TAG}"
|
||||
fi
|
||||
|
||||
if gh release view "${TAG}" >/dev/null 2>&1; then
|
||||
gh release upload "${TAG}" release/tmux-android.apk release/latest.json --clobber
|
||||
@ -157,4 +140,3 @@ jobs:
|
||||
--title "tmux Android ${VERSION_NAME}" \
|
||||
--notes "Android APK for tmux-ui remote testing."
|
||||
fi
|
||||
|
||||
|
||||
69
README.md
69
README.md
@ -12,18 +12,24 @@ APIs directly:
|
||||
- one-tap probe for the preset Tailscale APIs, showing health/version and
|
||||
session counts
|
||||
- native tmux session list
|
||||
- Sessions page with current API/server and loaded session count
|
||||
- native Projects page for kanban project grouping, project agents, project
|
||||
messages, add/remove session, create, and delete actions
|
||||
- create, rename, send command, split pane, select pane, kill pane, pin, mute,
|
||||
and kill session through HTTP API
|
||||
- open one live terminal viewer through `/ws/terminal`
|
||||
- native `/ws/events` listener for session invalidation and hook notifications
|
||||
- GitHub and Gitea update manifest mirrors with fallback
|
||||
- native API action center for health, server status, timeline, preferences,
|
||||
kanban projects, group messages, hook events, image file/URL upload, image
|
||||
preview info, and native image preview display
|
||||
- selectable GitHub or Gitea update manifest source
|
||||
- native Tools page for health, server status, timeline, preferences, hook
|
||||
events, image file/URL upload, image preview info, and native image preview
|
||||
display
|
||||
- mobile soft-key row for tmux-oriented input, including tmux prefix, detach,
|
||||
new window, previous/next window, Ctrl keys, arrows, page keys, and paste
|
||||
- automatic update checks against a GitHub Release manifest
|
||||
- APK download, SHA-256 verification, and installer handoff
|
||||
- automatic update checks against the selected release manifest
|
||||
- one-download-per-version APK cache, SHA-256 verification, and installer
|
||||
handoff
|
||||
- native Update and About pages for version/build type, protocol, permission,
|
||||
selected update source, and release information
|
||||
|
||||
## Server URL
|
||||
|
||||
@ -75,7 +81,12 @@ Create the base64 value from your release keystore:
|
||||
base64 -w 0 tmux-android-release.jks
|
||||
```
|
||||
|
||||
Publish a test build by pushing a `v*` tag. That creates a GitHub Release with:
|
||||
Branch builds and manual workflow runs create Actions artifacts only. Use them
|
||||
to verify grouped changes before publishing.
|
||||
|
||||
Publish a release build by pushing a `v*` tag. A tag should be reserved for a
|
||||
coherent feature/test batch, not every small UI or text change. Tag publishing
|
||||
creates a GitHub Release with:
|
||||
|
||||
```text
|
||||
https://github.com/neatstudio/tmux-browser-android/releases/latest/download/tmux-android.apk
|
||||
@ -102,17 +113,21 @@ messages unchanged: `attach`, `input`, `resize`, `scroll`, and `clear-history`.
|
||||
The first Android UI renders terminal output as monospace text with basic ANSI
|
||||
SGR color support. The terminal view stays bottom-aligned when output is short,
|
||||
auto-scrolls as data arrives, and adjusts its bottom inset when the soft keyboard
|
||||
opens. It is enough for shell-oriented remote testing, but it is not yet a
|
||||
complete xterm-compatible renderer for full-screen TUIs such as `vim` or `top`.
|
||||
opens. Rendering is throttled and the local terminal buffer is capped so opening
|
||||
busy sessions does not block the UI thread. Input typed before the terminal
|
||||
attach message is sent is queued and flushed after the WebSocket client is ready.
|
||||
It is enough for shell-oriented remote testing, but it is not yet a complete
|
||||
xterm-compatible renderer for full-screen TUIs such as `vim` or `top`.
|
||||
|
||||
The terminal toolbar and shortcut row include tmux prefix helpers. The app sends
|
||||
the same control bytes a keyboard would send, for example `Ctrl+B`, `Ctrl+B d`,
|
||||
`Ctrl+B c`, `Ctrl+B n`, and `Ctrl+B p`.
|
||||
|
||||
All app features are native Android controls. Complex server objects such as
|
||||
kanban projects, preferences, timeline events, group messages, and image metadata
|
||||
currently use native forms plus native JSON detail dialogs; image preview uses a
|
||||
native `ImageView`. The app does not load the browser UI.
|
||||
preferences, timeline events, group messages, and image metadata currently use
|
||||
native forms plus native JSON detail dialogs; kanban projects use a native
|
||||
project/agent list; image preview uses a native `ImageView`. The app does not
|
||||
load the browser UI.
|
||||
|
||||
## Permissions
|
||||
|
||||
@ -143,8 +158,11 @@ The public manual APK download is:
|
||||
https://github.com/neatstudio/tmux-browser-android/releases/latest/download/tmux-android.apk
|
||||
```
|
||||
|
||||
The app tries the selected update source first, then falls back to the GitHub
|
||||
manifest and the Gitea release API. The Gitea API endpoint is:
|
||||
The app checks only the selected update source. It does not probe GitHub and
|
||||
Gitea during the same update check. Choose the source in the app's `Update`
|
||||
page, or use a custom manifest/API URL.
|
||||
|
||||
The built-in Gitea API endpoint is:
|
||||
|
||||
```text
|
||||
https://gitea.neatcn.com/api/v1/repos/tmux/tmux-browser-android/releases/latest
|
||||
@ -159,10 +177,19 @@ https://gitea.neatcn.com/tmux/tmux-browser-android/releases/download/v0.1.7/tmux
|
||||
|
||||
In the app:
|
||||
|
||||
- Tap `Update` on the main screen to check `latest.json`, download the APK,
|
||||
verify SHA-256, and open Android's installer.
|
||||
- Open `More` -> `Open APK download` to download the current public APK in a
|
||||
browser.
|
||||
- Open `More` -> `Permissions / update status` to see the installed version,
|
||||
update manifest, APK URL, install permission state, and a `Check update`
|
||||
button.
|
||||
- Open the `Update` page to check `latest.json`, download the APK, verify
|
||||
SHA-256, and open Android's installer.
|
||||
- If the same version APK was already downloaded and its SHA-256 still matches,
|
||||
the app reuses that file instead of downloading it again.
|
||||
- If Android sends you to the unknown-app install permission screen, return to
|
||||
the app after allowing it; the app continues installing the already downloaded
|
||||
APK without another update check or download.
|
||||
- Open the `Update` page and tap `APK` to resolve the APK from the selected
|
||||
update source and open it in a browser.
|
||||
- Open the `Update` page and tap `Details` to see the installed version,
|
||||
selected update source, APK/Release resolver behavior, install permission
|
||||
state, and a `Check update` button.
|
||||
- Open the `Update` page and tap `App settings` for Android's full per-app
|
||||
permission/settings screen.
|
||||
- Open the `About` page to see the app version/build type, package name,
|
||||
API/protocol summary, selected update source, and update policy.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -71,6 +71,10 @@ final class TerminalSocketClient {
|
||||
}
|
||||
}
|
||||
|
||||
boolean isClosed() {
|
||||
return closed;
|
||||
}
|
||||
|
||||
private void run(String baseUrl, String sessionName, int cols, int rows) {
|
||||
try {
|
||||
URI uri = buildWsUri(baseUrl);
|
||||
@ -78,7 +82,6 @@ final class TerminalSocketClient {
|
||||
input = new BufferedInputStream(socket.getInputStream());
|
||||
output = new BufferedOutputStream(socket.getOutputStream());
|
||||
handshake(uri);
|
||||
listener.onConnected();
|
||||
sendMessage(
|
||||
"attach",
|
||||
"tabId", "android-" + System.currentTimeMillis(),
|
||||
@ -86,6 +89,7 @@ final class TerminalSocketClient {
|
||||
"cols", cols,
|
||||
"rows", rows
|
||||
);
|
||||
listener.onConnected();
|
||||
readLoop();
|
||||
} catch (Exception error) {
|
||||
if (!closed) {
|
||||
|
||||
@ -20,23 +20,29 @@ import java.io.InputStream;
|
||||
import java.net.HttpURLConnection;
|
||||
import java.net.URL;
|
||||
import java.security.MessageDigest;
|
||||
import java.util.ArrayList;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
|
||||
final class UpdateManager {
|
||||
private static final String PREF_PENDING_INSTALL_APK = "pending_install_apk";
|
||||
|
||||
interface Callback {
|
||||
void onChecking(boolean checking);
|
||||
void onMessage(String message);
|
||||
}
|
||||
|
||||
private interface ReleaseUrlPicker {
|
||||
String pick(ReleaseInfo info);
|
||||
}
|
||||
|
||||
private final Activity activity;
|
||||
private final SharedPreferences prefs;
|
||||
private final Callback callback;
|
||||
private final ExecutorService executor = Executors.newSingleThreadExecutor();
|
||||
private volatile boolean checkInProgress;
|
||||
private volatile boolean downloadInProgress;
|
||||
private File pendingInstallApk;
|
||||
|
||||
UpdateManager(Activity activity, SharedPreferences prefs, Callback callback) {
|
||||
this.activity = activity;
|
||||
@ -45,12 +51,17 @@ final class UpdateManager {
|
||||
}
|
||||
|
||||
void check(boolean userInitiated) {
|
||||
List<String> manifestUrls = getUpdateManifestUrls();
|
||||
if (checkInProgress) {
|
||||
postMessage("Update check already running");
|
||||
return;
|
||||
}
|
||||
String manifestUrl = getUpdateManifestUrl();
|
||||
checkInProgress = true;
|
||||
callback.onChecking(true);
|
||||
postMessage("Checking update...");
|
||||
postMessage("Checking update from " + hostLabel(manifestUrl) + "...");
|
||||
executor.execute(() -> {
|
||||
try {
|
||||
ReleaseInfo info = fetchFirstReleaseInfo(manifestUrls);
|
||||
ReleaseInfo info = fetchReleaseInfo(manifestUrl);
|
||||
if (info.versionCode <= BuildConfig.VERSION_CODE) {
|
||||
postMessage("Already up to date: " + BuildConfig.VERSION_NAME);
|
||||
return;
|
||||
@ -60,37 +71,52 @@ final class UpdateManager {
|
||||
} catch (Exception error) {
|
||||
postMessage(userInitiated ? "Update check failed: " + error.getMessage() : null);
|
||||
} finally {
|
||||
checkInProgress = false;
|
||||
activity.runOnUiThread(() -> callback.onChecking(false));
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
private List<String> getUpdateManifestUrls() {
|
||||
LinkedHashSet<String> urls = new LinkedHashSet<>();
|
||||
addUrl(urls, prefs.getString("update_url", BuildConfig.DEFAULT_UPDATE_URL));
|
||||
addUrl(urls, BuildConfig.DEFAULT_UPDATE_URL);
|
||||
addUrl(urls, BuildConfig.DEFAULT_GITEA_UPDATE_URL);
|
||||
return new ArrayList<>(urls);
|
||||
void openApkDownload() {
|
||||
openSelectedReleaseUrl("APK", info -> info.apkUrl);
|
||||
}
|
||||
|
||||
private void addUrl(LinkedHashSet<String> urls, String url) {
|
||||
if (url != null && !url.trim().isEmpty()) {
|
||||
urls.add(url.trim());
|
||||
}
|
||||
void openReleasePage() {
|
||||
openSelectedReleaseUrl("Release page", info -> info.releasePageUrl);
|
||||
}
|
||||
|
||||
private ReleaseInfo fetchFirstReleaseInfo(List<String> manifestUrls) throws Exception {
|
||||
Exception lastError = null;
|
||||
for (String manifestUrl : manifestUrls) {
|
||||
private void openSelectedReleaseUrl(String label, ReleaseUrlPicker picker) {
|
||||
if (checkInProgress) {
|
||||
postMessage("Update check already running");
|
||||
return;
|
||||
}
|
||||
String manifestUrl = getUpdateManifestUrl();
|
||||
checkInProgress = true;
|
||||
callback.onChecking(true);
|
||||
postMessage("Resolving " + label + " from " + hostLabel(manifestUrl) + "...");
|
||||
executor.execute(() -> {
|
||||
try {
|
||||
postMessage("Checking " + hostLabel(manifestUrl) + "...");
|
||||
return fetchReleaseInfo(manifestUrl);
|
||||
ReleaseInfo info = fetchReleaseInfo(manifestUrl);
|
||||
String url = picker.pick(info);
|
||||
if (url == null || url.trim().isEmpty()) {
|
||||
throw new IllegalStateException(label + " URL is missing");
|
||||
}
|
||||
activity.runOnUiThread(() -> openExternalUrl(url.trim(), label));
|
||||
} catch (Exception error) {
|
||||
lastError = error;
|
||||
postMessage(hostLabel(manifestUrl) + " failed");
|
||||
postMessage(label + " failed: " + error.getMessage());
|
||||
} finally {
|
||||
checkInProgress = false;
|
||||
activity.runOnUiThread(() -> callback.onChecking(false));
|
||||
}
|
||||
});
|
||||
}
|
||||
throw lastError == null ? new IllegalStateException("No update source configured") : lastError;
|
||||
|
||||
private String getUpdateManifestUrl() {
|
||||
String url = prefs.getString("update_url", BuildConfig.DEFAULT_UPDATE_URL);
|
||||
if (url == null || url.trim().isEmpty()) {
|
||||
return BuildConfig.DEFAULT_UPDATE_URL;
|
||||
}
|
||||
return url.trim();
|
||||
}
|
||||
|
||||
private String hostLabel(String url) {
|
||||
@ -173,8 +199,13 @@ final class UpdateManager {
|
||||
}
|
||||
|
||||
private void downloadAndInstall(ReleaseInfo info) {
|
||||
if (downloadInProgress) {
|
||||
postMessage("Update download already running");
|
||||
return;
|
||||
}
|
||||
downloadInProgress = true;
|
||||
callback.onChecking(true);
|
||||
postMessage("Downloading " + info.versionName + "...");
|
||||
postMessage("Preparing " + info.versionName + "...");
|
||||
executor.execute(() -> {
|
||||
try {
|
||||
File apk = downloadApk(info);
|
||||
@ -189,6 +220,7 @@ final class UpdateManager {
|
||||
} catch (Exception error) {
|
||||
postMessage("Update download failed: " + error.getMessage());
|
||||
} finally {
|
||||
downloadInProgress = false;
|
||||
activity.runOnUiThread(() -> callback.onChecking(false));
|
||||
}
|
||||
});
|
||||
@ -200,7 +232,12 @@ final class UpdateManager {
|
||||
throw new IllegalStateException("Cannot create update cache");
|
||||
}
|
||||
File apk = new File(dir, "tmux-android-" + info.versionCode + ".apk");
|
||||
if (isCachedApkValid(apk, info)) {
|
||||
postMessage("Using downloaded APK");
|
||||
return apk;
|
||||
}
|
||||
|
||||
postMessage("Downloading " + info.versionName + "...");
|
||||
HttpURLConnection connection = (HttpURLConnection) new URL(info.apkUrl).openConnection();
|
||||
connection.setConnectTimeout(12000);
|
||||
connection.setReadTimeout(60000);
|
||||
@ -217,18 +254,32 @@ final class UpdateManager {
|
||||
return apk;
|
||||
}
|
||||
|
||||
private boolean isCachedApkValid(File apk, ReleaseInfo info) throws Exception {
|
||||
if (!apk.exists() || apk.length() <= 0) {
|
||||
return false;
|
||||
}
|
||||
if (info.sha256.isEmpty()) {
|
||||
return true;
|
||||
}
|
||||
return sha256(apk).equalsIgnoreCase(info.sha256);
|
||||
}
|
||||
|
||||
private void installApk(File apk) {
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O
|
||||
&& !activity.getPackageManager().canRequestPackageInstalls()) {
|
||||
pendingInstallApk = apk;
|
||||
prefs.edit().putString(PREF_PENDING_INSTALL_APK, apk.getAbsolutePath()).apply();
|
||||
Intent settingsIntent = new Intent(
|
||||
Settings.ACTION_MANAGE_UNKNOWN_APP_SOURCES,
|
||||
Uri.parse("package:" + activity.getPackageName())
|
||||
);
|
||||
activity.startActivity(settingsIntent);
|
||||
Toast.makeText(activity, "Allow installs, then run update again", Toast.LENGTH_LONG).show();
|
||||
Toast.makeText(activity, "Allow installs, then return to continue", Toast.LENGTH_LONG).show();
|
||||
postMessage("Install permission required");
|
||||
return;
|
||||
}
|
||||
pendingInstallApk = null;
|
||||
prefs.edit().remove(PREF_PENDING_INSTALL_APK).apply();
|
||||
|
||||
Uri apkUri = UpdateFileProvider.getUriForFile(
|
||||
activity,
|
||||
@ -247,6 +298,41 @@ final class UpdateManager {
|
||||
}
|
||||
}
|
||||
|
||||
private void openExternalUrl(String url, String label) {
|
||||
try {
|
||||
activity.startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(url)));
|
||||
postMessage("Opened " + label);
|
||||
} catch (ActivityNotFoundException error) {
|
||||
postMessage("No app can open " + label);
|
||||
}
|
||||
}
|
||||
|
||||
void resumePendingInstall() {
|
||||
File apk = pendingInstallApk;
|
||||
if (apk == null) {
|
||||
String path = prefs.getString(PREF_PENDING_INSTALL_APK, "");
|
||||
if (path != null && !path.isEmpty()) {
|
||||
apk = new File(path);
|
||||
pendingInstallApk = apk;
|
||||
}
|
||||
}
|
||||
if (apk == null) {
|
||||
return;
|
||||
}
|
||||
if (!apk.exists() || apk.length() <= 0) {
|
||||
pendingInstallApk = null;
|
||||
prefs.edit().remove(PREF_PENDING_INSTALL_APK).apply();
|
||||
postMessage("Downloaded APK is no longer available");
|
||||
return;
|
||||
}
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O
|
||||
&& !activity.getPackageManager().canRequestPackageInstalls()) {
|
||||
return;
|
||||
}
|
||||
postMessage("Continuing APK install...");
|
||||
installApk(apk);
|
||||
}
|
||||
|
||||
private static byte[] readAllBytes(InputStream input) throws Exception {
|
||||
java.io.ByteArrayOutputStream output = new java.io.ByteArrayOutputStream();
|
||||
byte[] buffer = new byte[16 * 1024];
|
||||
|
||||
@ -70,6 +70,8 @@ Implemented now:
|
||||
|
||||
- configurable base URL, defaulting to `http://100.89.0.116:3000`
|
||||
- support for Tailscale URLs such as `http://100.x.y.z:3000`
|
||||
- native multi-page shell with `Sessions`, `Projects`, `Tools`, `Update`, and
|
||||
`About`
|
||||
- native session list from `GET /api/sessions`
|
||||
- create, rename, command send, split, pane select, pane kill, pin, mute, and
|
||||
kill session through documented session/preference endpoints
|
||||
@ -78,18 +80,50 @@ Implemented now:
|
||||
- bottom shortcut bar for `Esc`, `Tab`, `Ctrl+C`, `Ctrl+V`, arrows, page keys,
|
||||
tmux prefix actions, and paste
|
||||
- shortcut delivery through the terminal WebSocket `input` message
|
||||
- native action center for health, server status, timeline, preferences, kanban
|
||||
projects, group messages, hook events, image file/URL upload, image preview
|
||||
metadata, and native image preview display
|
||||
- native Projects page for kanban project grouping, project agents, project
|
||||
messages, add/remove session, create, and delete actions
|
||||
- native Tools page for health, server status, timeline, preferences, hook
|
||||
events, image file/URL upload, image preview metadata, and native image
|
||||
preview display
|
||||
- GitHub Actions APK build
|
||||
- release manifest `latest.json`
|
||||
- APK download, SHA-256 verification, and installer handoff
|
||||
- selected-source update checks; GitHub and Gitea are not probed in the same
|
||||
update check
|
||||
- one-download-per-version APK cache, SHA-256 verification, and installer
|
||||
handoff
|
||||
- permission/about surfaces for unknown-app install status, notification status,
|
||||
app settings, app version/build type, package name, selected update source, and
|
||||
HTTP/WebSocket API/protocol summary
|
||||
|
||||
## Update And Release Policy
|
||||
|
||||
The Android app cannot silently replace itself. It may download a newer APK and
|
||||
open Android's package installer, but the user must approve the install. On
|
||||
Android 8+, the user may also need to allow this app to install unknown apps.
|
||||
|
||||
The app checks exactly one update source per run: the selected manifest/API URL.
|
||||
GitHub is the default public source. Gitea is available as a public mirror, but
|
||||
the app does not fall back across both providers during a normal check. This
|
||||
keeps update behavior predictable on mobile networks and avoids duplicate
|
||||
provider checks.
|
||||
|
||||
Downloaded APKs are cached by `versionCode`. If a cached APK exists and its
|
||||
SHA-256 matches the manifest, the app reuses it instead of downloading the same
|
||||
version again. This matters when Android redirects the user to unknown-app
|
||||
install settings before the installer can run. After the user grants that
|
||||
permission and returns to the app, the app resumes installation of the pending
|
||||
APK instead of asking the user to run update again.
|
||||
|
||||
Only `v*` tags publish GitHub Releases. Main branch builds and manual workflow
|
||||
runs are for CI artifacts and should be used to validate grouped changes. Do not
|
||||
publish a new tag for every small UI copy or layout change; publish when there
|
||||
is a useful feature or test batch for phone-side validation.
|
||||
|
||||
## Native Roadmap
|
||||
|
||||
To converge with the upstream mobile design, the next implementation should add
|
||||
native Android modules in this order:
|
||||
|
||||
1. richer native layouts for kanban, group messages, timeline, and preferences
|
||||
1. richer native layouts for group messages, timeline, and preferences
|
||||
2. `TerminalCore` with ANSI parsing, cursor state, colors, and dirty rows
|
||||
3. configurable shortcut bar backed directly by WebSocket `input`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user