# uu-remote-linux · Unofficial Linux host for NetEase UU Remote [简体中文](README.md) | **English** > **A note first** > > NetEase UU Remote (网易 UU 远程) is a great remote-desktop tool, but there is no Linux version on its > official website. So, with the help of Claude and Codex, I wrote this open-source Linux host: install it, > and you can control your Linux machine from the official Mac / Windows / mobile UU Remote clients. > > This is a personal hobby project. **It is not affiliated with NetEase and is not an official client.** > If NetEase considers this project infringing or inappropriate, please DM me on X > **[@ai_fengshou](https://x.com/ai_fengshou)** and I will take it down right away.

QR login window on the Linux host

The QR login window shown on first run (QR code blurred). The UI is in Chinese, like the official app.

## What it is - A native Linux program written in Rust: no Wine, no Windows or macOS components. - Log in by scanning a QR code with your own UU Remote account. The Linux machine then appears in the official clients' device list and is used just like a Windows host. - **Host only.** To control other machines you still use the official Mac / Windows / mobile apps. ## Features | Feature | Notes | |---|---| | QR login | GTK login window (or a terminal QR code with `login --no-gui`); expired codes refresh automatically; the service opens the login window by itself when credentials are missing or expired | | Remote desktop | H.264 video, NVENC hardware encoding on NVIDIA GPUs, libx264 otherwise; the viewer draws its local pointer, so there is no double cursor | | Mouse / keyboard | Absolute and relative motion, clicks, wheel, keys; no spurious key repeat on high-latency links; optional uinput virtual devices on Wayland (layout independent, see below) | | Terminal shortcuts | Mac viewers send both Cmd and Ctrl as Ctrl. In a focused terminal window Ctrl+V / Cmd+V become Ctrl+Shift+V (paste); Ctrl+C always interrupts, copy with Cmd+Shift+C (X11) | | Pointer shape | Remote cursor shape is mirrored to the viewer (X11) | | Clipboard | Two-way text sync | | Quality / frame rate / resolution | Auto, Original 20M, Ultra 8M, HD 2M, custom; 30/60/90/144 fps; "other resolutions" are scaled by the encoder, the host monitor is left untouched | | Sound | System audio captured from PulseAudio / PipeWire and sent as Opus | | File transfer | Upload, download (including folders), create folder, rename, delete | | Terminal | The official "Terminal" tool, PTY sessions, multiple sessions, rename | | Lock state and auto unlock | Lock state is reported to the viewer; with "auto unlock" enabled in the client, the password is verified with PAM and the session is unlocked | | Lock after remote session | Stored on the host, so it still applies after reconnecting | | Mute host while controlled | Host speakers are muted while the viewer still hears the sound; the previous mute state is restored afterwards | | System actions | Lock, show desktop, task manager (system monitor), reboot, shut down | | Port mapping | The official "port mapping" tool: forwards a local port on the viewer to an address reachable from the Linux host (e.g. 127.0.0.1:22); `UU_PORT_MAPPING=0` disables it | | Reconnects | Every tool window has its own connection; they do not disturb each other | | Headless servers | Goes online without a monitor with terminal, file transfer and port mapping; an Xvfb virtual desktop gives a full remote desktop (see below) | Desktop connection boundaries and host startup clear stale input; delayed events from an old desktop cannot affect its replacement. X11 clears pressed state on the authenticated display (including physical keys whose origin it cannot distinguish); uinput clears only this host's virtual devices, and Portal only its authorized session. Independent file/terminal tool peers do not reset input. ## Supported Linux desktops | Desktop | Display protocol | Status | Build | |---|---|---|---| | GNOME (Ubuntu 24.04) | X11 / Xorg | ✅ In daily use on real hardware; every feature above accepted | default | | KDE Plasma | X11 | ✅ Tested in a VM | default | | Xfce | X11 | ✅ Tested in a VM | default | | Cinnamon / MATE | X11 | ✅ Tested in a VM | default | | Hyprland | Wayland (native wlroots protocols) | 🧪 Experimental, tested in a VM (some features limited, see below) | `--features wayland` | | GNOME / KDE Plasma | Wayland (xdg-desktop-portal) | 🧪 Experimental, tested in a VM (some features limited, see below) | `--features wayland,portal` | Apart from GNOME on X11, these desktops have been tested in virtual machines so far. If something goes wrong on real hardware, please [open an issue](../../issues) with your distribution, desktop, GPU and the relevant lines from `journalctl --user -u uuremote-native.service`. Wayland limits: single screen, fixed resolution. The native Hyprland backend now pipelines two shm screencopy buffers and passes the viewer's requested fps to both capture pacing and the encoder. Actual fps remains limited by the compositor, rendering and readback (the old serial path measured about 16–22 fps at 2560x1600; the pipeline is VM-measured only, not a hardware guarantee). The portal backend does not support screen wake or dynamic resolution yet; the clipboard syncs while the viewer's remote window has focus. On the first connection the desktop asks for "Remote Desktop / Screen Sharing" permission; the permission is remembered once granted. Native Wayland experiments: `UU_WAYLAND_PIPELINE=0` disables pipelining for comparison. `UU_WAYLAND_DMABUF=1` explicitly tries dma-buf → GBM CPU mapping (off by default; requires runtime libgbm; `UU_WAYLAND_DMABUF_DEVICE` overrides `/dev/dri/renderD128`). Only single-plane 8-bit RGB with an advertised linear modifier is supported; failure falls back to SHM. The virgl VM verified fallback only: successful import, mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI; `UU_VIDEO_ENCODER=vaapi` still uploads CPU frames through FFmpeg. ## Not implemented / not supported | Feature | Status | |---|---| | Switching between multiple monitors | In progress | | True color (4:4:4) | Not implemented; not declared in the handshake, so the client does not enable it | | HDR | Not implemented | | Super screen / virtual display | Not implemented | | Privacy screen on the host | Not implemented | | Microphone (viewer audio played on the host) | Not implemented (needs a virtual sound card) | | Plugins such as the WoW queue notifier | Not supported; the client is told that no plugins exist | | Access before login (greeter / no user logged in) | The greeter cannot be controlled; without a logged-in user use headless mode or a virtual desktop (see below) | | Relay connections on restrictive networks | Uses the ICE servers provided by the UU cloud; complex network setups are not thoroughly tested | | Acting as a viewer (controlling other machines from Linux) | Out of scope | ## Installation ### 1. Dependencies (Ubuntu / Debian) ```sh sudo apt install build-essential pkg-config \ libx11-dev libxext-dev libxtst-dev libxfixes-dev \ libgtk-3-dev ffmpeg # optional: Wayland backend sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard # optional: GNOME/KDE portal backend sudo apt install libglib2.0-dev libpipewire-0.3-dev ``` - A Rust toolchain is required (). - `libgtk-3-dev` is optional. Without GTK, login works with a QR code in the terminal (`UU_NO_GTK=1` disables the login window explicitly). - On NVIDIA GPUs use an FFmpeg build with `h264_nvenc`; otherwise the CPU encoder (libx264) is used. ### 2. Build ```sh cargo build --release # X11 cargo build --release --features wayland # + Hyprland cargo build --release --features wayland,portal # + GNOME/KDE on Wayland ``` ### 3. Log in Run inside your graphical session: ```sh ./target/release/uuremote-server login ``` Scan the code with the **NetEase UU Remote mobile app** and confirm. Credentials are stored only on this machine, in `~/.config/uuremote/config.json` (mode 0600). ### 4. Run as a user service `~/.config/systemd/user/uuremote-native.service`: ```ini [Unit] Description=UU Remote Linux host (unofficial) After=graphical-session.target [Service] Environment=RUST_LOG=info # X11 desktops need the display; on GNOME, XAUTHORITY is usually /run/user//gdm/Xauthority Environment=DISPLAY=:0 ExecStart=%h/.local/bin/uuremote-server Restart=always RestartSec=5 [Install] WantedBy=default.target ``` ```sh install -Dm755 target/release/uuremote-server ~/.local/bin/uuremote-server systemctl --user daemon-reload systemctl --user enable --now uuremote-native.service journalctl --user -u uuremote-native.service -f # online once you see availability=Some("ready") ``` If you have not logged in yet, the service opens the QR login window on your desktop. ### 5. uinput virtual keyboard/mouse on Wayland (recommended) On Wayland (especially GNOME/KDE via the portal) the default input path needs portal consent and some keyboard layouts drop symbols such as the underscore. Once the logged-in user may access `/dev/uinput`, the host switches to kernel virtual devices that send physical key codes: ```sh echo 'KERNEL=="uinput", SUBSYSTEM=="misc", OPTIONS+="static_node=uinput", TAG+="uaccess"' | \ sudo tee /etc/udev/rules.d/60-uu-remote-linux-uinput.rules sudo udevadm control --reload && sudo udevadm trigger --name-match=uinput ``` `uaccess` grants access only to the user sitting at the machine. `UU_INPUT_BACKEND=uinput|native` forces a backend. X11 keeps XTest by default because it handles held keys correctly on high-latency links. ## Servers without a monitor **Headless mode** (terminal, file transfer and port mapping only): add `Environment=UU_DESKTOP_BACKEND=none` to the service and run `loginctl enable-linger $USER`, so the systemd user manager (with `XDG_RUNTIME_DIR` and the user D-Bus) starts at boot without a login. The viewer's remote desktop keeps showing "connecting" in this mode; that is expected. Log in once with `uuremote-server login --no-gui` (QR in the terminal). **Virtual desktop**: for a full remote desktop, run a desktop session (Xfce recommended) on an Xvfb screen: ```sh sudo apt install xvfb xauth x11-utils dbus-x11 dbus-user-session xfce4 # or another session, chosen with UU_VIRTUAL_SESSION install -Dm755 contrib/virtual-desktop/uu-virtual-desktop ~/.local/bin/uu-virtual-desktop install -Dm644 contrib/virtual-desktop/uu-virtual-desktop.service ~/.config/systemd/user/uu-virtual-desktop.service install -Dm644 contrib/virtual-desktop/virtual-display.conf ~/.config/systemd/user/uuremote-native.service.d/virtual-display.conf loginctl enable-linger $USER systemctl --user daemon-reload && systemctl --user enable --now uu-virtual-desktop.service systemctl --user restart uuremote-native.service ``` The virtual screen is `:99`, 1920x1080 by default. Xvfb has no GPU acceleration, so it is a little less smooth than a real display; NVENC is still used for encoding when an NVIDIA GPU is present. The script exports `DISPLAY` to the systemd user session so D-Bus-activated programs open on the virtual screen; on a machine that also runs a real desktop session set `UU_VIRTUAL_BUS=private` so the real session is not affected. To make a GPU drive a real (non-Xvfb) desktop without a monitor, use a dummy HDMI plug or load an EDID file with the kernel parameter `drm.edid_firmware=`, then install as for a normal X11 desktop. ## Configuration Common environment variables: | Variable | Purpose | |---|---| | `UU_CONFIG` | Config file path (default `~/.config/uuremote/config.json`) | | `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless) | | `UU_INPUT_BACKEND` | `auto` (default: uinput on Wayland when accessible) / `uinput` / `native` | | `UU_TERMINAL_SHORTCUTS=0` | Disable the Ctrl+V paste rewrite in terminal windows | | `UU_VIDEO_ENCODER` | `cpu`: libx264; `vaapi`: opt-in Intel/AMD; `nvenc`: force NVENC; unset: NVENC only when an NVIDIA driver is loaded, else CPU | | `UU_FFMPEG_ROOT` | Use FFmpeg from this prefix | | `UU_AUDIO=0` | Disable sound; `UU_AUDIO_SOURCE` picks the PulseAudio source | | `UU_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing | | `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) | Host settings such as "lock after remote session" and "mute host" are stored in `~/.config/uuremote/host_settings.json`. ## Let an AI agent install or develop it If you use Claude Code, Codex, Cursor or a similar coding agent, have it read [AGENTS.md](AGENTS.md) first. It is written for language models: build and install steps, a code map, protocol notes and development rules, enough to take over installation or development. ## How it works ```mermaid flowchart LR App["Official client
Mac / Windows / mobile"] <-- "WebRTC: video · audio · data channels" --> Host["uuremote-server
(Linux)"] App <-- signaling --> Cloud["UU Remote cloud"] Host <-- "Socket.IO signaling · device login" --> Cloud Host --> X11["X11 / Wayland
capture and input"] Host --> FF["FFmpeg
H.264 / Opus"] Host --> Sys["PAM · logind · PipeWire"] ``` - The host registers with UU Remote as a "Windows PC", so the official clients recognize it directly. - The screen is encoded to H.264 and the sound to Opus with FFmpeg, both sent over WebRTC; keyboard, mouse, clipboard, files and terminal use WebRTC data channels. - Protocol details were learned by observing the official clients' traffic and analyzing their publicly released programs, for interoperability only. This repository contains **no** NetEase programs, logos or assets. ## Security and privacy - Logs never contain keystrokes, terminal text, clipboard contents, file contents, passwords or tokens. - For auto unlock the password is stored in the **viewer** (the official client). The host only checks it once with PAM; it is never written to disk or logs. - Only devices logged in to the same UU account can connect. Keep your UU account safe. ## License Released under the [GPL-3.0](LICENSE): you may use, modify and redistribute it, but redistributed versions (including modified ones) must also be released under the GPL-3.0. ## Disclaimer - "NetEase", "网易" and "UU 远程 / UU Remote" are names and trademarks of NetEase, Inc. This project is not affiliated with, authorized or endorsed by NetEase. - It was built for interoperability. Use it in accordance with the UU Remote user agreement and your local laws, at your own risk. - NetEase or other rights holders with concerns: please contact [@ai_fengshou](https://x.com/ai_fengshou) on X and I will cooperate or take the project down. ## Acknowledgements - The NetEase UU Remote team, for a remote tool that is a pleasure to use. - [webrtc-rs](https://github.com/webrtc-rs/webrtc), FFmpeg, GTK and the other open-source projects this builds on. - Most of the code was written with the help of Claude and Codex. ### VAAPI (opt-in / 显式启用) `UU_VIDEO_ENCODER=vaapi` selects Intel/AMD H.264 VAAPI; `UU_VAAPI_DEVICE` defaults to `/dev/dri/renderD128` (render-node permissions required). No automatic VAAPI selection. Both FFmpeg process and `--features inproc-av` upload NV12 frames to a VAAPI frame pool. VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1, AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264 with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). AMD and the `inproc-av` VAAPI path are not hardware-verified. ### Virtual audio / 虚拟声卡 The viewer's 静音运行 switch creates the null sink `uu-remote-sink`, moves streams from the original default output and captures `uu-remote-sink.monitor`. New output goes to this sink; streams explicitly pinned to other outputs are untouched. The last desktop session restores the previous default output and unloads the module. `mute_permanent` retains the physical mute policy, but still releases the virtual sink. A private recovery record beside the config and a process lock recover crash leftovers on startup. `pactl` is used when installed (PulseAudio / PipeWire-pulse); plain PipeWire systems without it (default Ubuntu desktop) use `pw-cli`/`wpctl` for the same sink and WirePlumber moves playing streams. Accepted on Ubuntu 24.04 with the official Mac viewer. When routing is unavailable, the existing mute/monitor path remains. Changing the switch restarts only the scoped audio encoder; normal non-muted capture is unchanged. `virtual-audio-probe` temporarily routes output for five seconds and restores it (local diagnostic). ### Virtual desktop user bus The supervisor imports DISPLAY and XAUTHORITY into the linger user bus, waits for authenticated X11 readiness, and keeps its cleanup trap alive. The sample drop-in uses `%t/uu-virtual-99.Xauthority`. Use a dedicated headless account. See the [setup and official Mac acceptance checklist](contrib/virtual-desktop/ACCEPTANCE.md). ### Arch Linux / Omarchy ```sh sudo pacman -S --needed base-devel rust pkgconf clang ffmpeg libx11 libxext libxtst libxfixes gtk3 \ wayland libxkbcommon wl-clipboard libpipewire glib2 libpulse cargo test --locked --features wayland cargo build --release --features wayland ``` Omarchy uses Hyprland: run in its user session, select `UU_DESKTOP_BACKEND=wayland`, and retain `WAYLAND_DISPLAY` / `XDG_RUNTIME_DIR`. This requires wlr-screencopy and the virtual input protocols supported by Hyprland; other compositors may need `--features wayland,portal`. For uinput, load `uinput` and apply the uaccess rule above; seat ACLs require an active login. For unattended accounts, explicitly restrict `/dev/uinput` access to a dedicated group. This permission can inject into the whole seat, including lock/greeter screens. `UU_INPUT_BACKEND=uinput` requests kernel devices; verify startup actually reports uinput. Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils` for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`. Rolling Arch FFmpeg may be newer than supported `inproc-av` (FFmpeg 6.x); use the default process pipeline or build against a separate FFmpeg 6 prefix. Do not downgrade the system FFmpeg. User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md). ### Experimental KMS / 实验后端 `--features kms` plus explicit `UU_DESKTOP_BACKEND=kms` enables a limited linear-framebuffer prototype; `UU_KMS_DEVICE=/dev/dri/card0`. Requires libdrm headers and deliberately granted `cap_sys_admin+ep`, plus card-node access. It is never automatically selected or granted privileges. This capability is broad: it applies to the whole network-facing process and can expose greeter/lock screens that portal consent would hide. Use it only on a disposable machine with a reviewed binary; inspect with `getcap`, revoke with `sudo setcap -r `. A VM greeter capture was solid black, so lock/greeter screens are not supported. The VM GDM greeter capture was solid black (failed visual acceptance); lock/greeter support and Intel/AMD hardware remain unverified. Use uinput for input; clipboard is unavailable without a desktop session. No default release behavior changes. No official "no desktop" error code was found for headless desktop offers, so the existing offer behavior is retained.