elsewindow starts one GUI application on a remote Linux host and shows
its windows through Xpra. One owned OpenSSH ControlMaster carries every Xpra
control channel; the command opens no forwarding or Xpra TCP listener and
cleans only the server, application process group, sockets, and runtime state
created by that invocation.
The application renders through the remote Wayland compositor and remote GPU. Only Xpra picture, input, clipboard, notification, and control traffic crosses SSH.
The Python distribution requires Linux, CPython 3.13 or 3.14, OpenSSH,
false, a local graphical session, and compatible Xpra packages on both
systems. Optional desktop features
have separate system prerequisites: missing support produces a warning and
disables only that feature for the session. Startup never installs packages.
Install the latest published release with pip or pipx:
python3.14 -m pip install elsewindow
# or: pipx install elsewindow
elsewindow --prepare-xpra
elsewindow --ssh-alias agents-a -- xtermThe version prepared by this source tree is recorded only in .version.
Check packaged versions, profile digests, Linux support, and local commands without opening a connection:
elsewindow --diagnoseThe published distribution resolves the exact reviewed
ssh-wrapper release pinned only in
requirements.in.
For a source checkout, prepare the hash-locked runtime and use the repository
launcher from any working directory:
make runtime-venv
./bin/elsewindow --helpThis one make target prepares the isolated Elsewindow runtime and a separate
system-Python venv for local Xpra. The latter keeps GTK and native Xpra modules
in their system packages while installing a hash-locked matching PyOpenGL and
accelerator pair. Session startup never invokes pip or changes system packages.
Both environments are selected automatically beneath .venvs/<machine-user-key>/,
so each machine prepares its own Python and native additions in a shared checkout.
See checkout setup for migration
and system-command behavior.
Use a direct authority when an OpenSSH alias is not appropriate:
elsewindow \
--host host.example \
--user desktop-user \
--port 2222 \
-- /opt/application/bin/applicationSee the CLI reference for every option, default, and allowed
value, including encoding/network profiles, clipboard policy, logging, and
persistence. Repeat --env to set remote
application variables or copy explicitly named local values. Reviewed profile
arguments come from the packaged YAML mirrors.
The Xpra guide covers hardware, application, and lifecycle
behavior; the security model explains clipboard and logging
trust boundaries.
tools/install_xpra_release.py is a standalone
standard-library installer for Debian 13 and Ubuntu 26.04. It resolves the
newest canonical package release from kogeler/xpra:develop, verifies archive
and DEB contents before mutation, prints the exact installed Xpra inventory,
and requires interactive confirmation before purging that inventory. It uses
APT for the validated local packages and dependencies. Pass
--release NAME (a release name or exact tag) to install a specific canonical
release instead of the newest one; with a streamed script use
/usr/bin/python3 - --release NAME.
Elsewindow deliberately uses this maintained fork rather than treating a generic upstream Xpra build as interchangeable. Project development uncovered dozens of blocking Xpra defects: some fixes were accepted as direct upstream contributions, some were implemented by the upstream maintainer after issue reports, and some were not accepted after technical disagreements. The last category requires continued maintenance of additional fork patches. The Xpra guide explains the resulting user compatibility boundary.
Review the installer and the security contract. The streamed
route below is pending until the first reviewed main push; it must not be
treated as available before then:
( set -o pipefail; curl --proto '=https' --tlsv1.2 -fsSL 'https://raw.githubusercontent.com/kogeler/elsewindow/main/tools/install_xpra_release.py' | /usr/bin/python3 - )Do not prefix the pipeline or Python process with sudo. When privilege is
needed, the reviewed script reads purge confirmation from the controlling
terminal and invokes /usr/bin/sudo itself only for its root-owned staging and
APT transaction.
After the first release, GitHub Releases provide elsewindow-linux-amd64 and
elsewindow-linux-arm64. These native one-file ELF executables bundle
Elsewindow, CPython, ssh-wrapper, version metadata, and the reviewed YAML
profiles, and the local Xpra setup code and dependency lock. They do not bundle
OpenSSH, Xpra, Podman, GPU drivers, VA-API, or
distribution packages. Verify the release's SHA256SUMS.txt, make the selected
file executable, run ./elsewindow-linux-amd64 --prepare-xpra, then
./elsewindow-linux-amd64 --diagnose (or the arm64 equivalents) before starting
a session. Preparation uses the system Xpra Python, not the bundled interpreter,
and needs neither a checkout nor GNU Make. See the
setup reference for prerequisites and storage.
- Rendered documentation site
(published by the first reviewed direct
mainpush) - Getting started
- Complete CLI reference
- Xpra behavior and lifecycle
- Security model
- Architecture
- Development and validation
- Contributing
- Maintainer CI contract
- Dependency maintenance
- Release maintenance
The Pages workflow renders these same maintained Markdown files and validates
every generated route, local link, anchor, canonical URL, sitemap, crawler
file, and advertised llms.txt route without network access.
make live-test resolves the newest fork release, builds checksum-bound Ubuntu
target and Debian client images, and runs ordinary and persistent lifecycle cases
on a private rootless Podman network. The payload excludes elsewindow/ source
and clean-installs the already verified wheel. The harness generates a fresh
Ed25519 key, performs exactly one authentication per invocation, verifies a visible
window and picture updates through the production profile assembler, preserves
an unrelated session, and removes only its labelled containers and network.
All wheel, test, and key material enters through validated tar streams; the
test uses no host bind, data volume, or copy channel.
Persistent cases exercise real systemd user services, linger consent, resumption
after client/SSH loss, stable application identity and cleanup on application
exit. The same matrix checks all four local/remote log sources in the local
journal and terminal, and only remote sources in the server journal, at the
selected log level. Enable this opt-in mode with
--persistent; see the CLI reference.
Released under the MIT License.