goMarkableStream

goMarkableStream

Screen recording 2026-02-04 11.24.44.webm

Overview

goMarkableStream is a lightweight and user-friendly application designed specifically for the reMarkable tablet.

Its primary goal is to enable users to stream their reMarkable tablet screen to a web browser without the need for any hacks or modifications that could void the warranty.

Table of Contents

• Device Support
• Available Binaries
• Quick Start
• Systemd Service Setup
• Subcommands
• Configuration
• Presentation Mode
• Technical Details
• Compilation
• Contributing

Device Support

Actively supported and tested:

• reMarkable 2 with firmware 3.24+

Experimental (not actively tested):

• reMarkable Paper Pro - initial support, some features may not work as expected

Version Support

The latest version of goMarkableStream is actively developed and tested on reMarkable 2 with firmware 3.24+.

For older firmware versions:

• Firmware = 3.4 and = 0.8.6 and = 3.6 and = 0.11.0 (may work, but not actively tested)

Features

Core Benefits

• No Warranty Voiding: Operates within the reMarkable tablet's intended functionality without unauthorized modifications.
• No Subscription Required: Completely free to use, with no subscription fees.
• No Client-Side Installation: Access directly through a web browser, no additional software needed.
• HTTPS by Default: Secure encrypted connections out of the box.

Streaming

• Full Color Support: RGBA streaming with full color from PDFs and documents (firmware 3.24+).
• High Performance: WebGL-based rendering for smooth, efficient display.
• Delta Compression: Bandwidth-efficient streaming that only transmits changed pixels.
• Configurable Frame Rate: Adjust streaming rate via URL parameters.

Remote Access (Tailscale)

• Tailscale Integration: Access your reMarkable from anywhere on your tailnet without exposing it to the public internet.
• Tailscale Funnel: Share your screen publicly via Tailscale Funnel with automatic QR code generation.
• Ephemeral Mode: Register as a temporary node that's automatically removed when disconnected.

Interaction

• Laser Pointer: Red laser pointer that follows pen hover position (toggle with L key).
• Gesture Support: Swipe gestures for slide navigation, integrated with Reveal.js presentations.
• Keyboard Shortcuts: R for rotation, L for laser pointer, ? for help overlay.
• Layer Control: Toggle drawing layer above or below embedded content.

Presentation Mode

• Overlay Feature: Embed presentations or videos in the background for live annotation.
• Reveal.js Integration: Full slide control directly from your reMarkable tablet.

UI

• Side Menu: Collapsible sidebar for rotation, layer control, and Funnel toggle.
• Connection Status: Visual indicator showing connection state with auto-reconnection.
• Help Overlay: Press ? to view all available gestures and shortcuts.

Available Binaries

Each release provides four binary variants:

Which binary should I use?

• Use RMPRO variants for reMarkable Paper Pro
• Use RM2 variants for reMarkable 2
• Use -lite variants if you don't need Tailscale remote access (smaller binary size)

Quick Start

1. Connect your reMarkable to your computer via USB-C cable and SSH into it:

ssh [email protected]

1. Download and run (choose your device):

# Set your device: RM2 for reMarkable 2, RMPRO for Paper Pro
DEVICE=RM2

# Download latest version
VERSION=$(wget -q -O - https://api.github.com/repos/owulveryck/goMarkableStream/releases/latest | grep tag_name | awk -F\" '{print $4}')
wget -O goMarkableStream https://github.com/owulveryck/goMarkableStream/releases/download/$VERSION/gomarkablestream-$DEVICE
chmod +x goMarkableStream
./goMarkableStream

1. Open https://10.11.99.1:2001 in your browser
   • Default credentials: admin / password

Note: You can also connect via Wi-Fi using your tablet's IP address or remarkable.local. (with trailing dot) on Apple devices.

For lite versions (without Tailscale), append -lite to the device name: gomarkablestream-RM2-lite

To update to a new version, use the built-in download command: ./goMarkableStream download (see Subcommands).

Errors due to missing packages

If you get errors such as wget: note: TLS certificate validation not implemented, download goMarkableStream on your local computer and copy it over:

# On your local computer (set DEVICE to RM2 or RMPRO)
DEVICE=RM2
VERSION=$(wget -q -O - https://api.github.com/repos/owulveryck/goMarkableStream/releases/latest | grep tag_name | awk -F\" '{print $4}')
wget -O goMarkableStream https://github.com/owulveryck/goMarkableStream/releases/download/$VERSION/gomarkablestream-$DEVICE
chmod +x goMarkableStream

# Copy to reMarkable (via USB-C)
scp ./goMarkableStream [email protected]:/home/root/goMarkableStream

# SSH and run
ssh [email protected] ./goMarkableStream

Setup as a Systemd Service

The easiest way to install goMarkableStream as a systemd service is using the built-in install subcommand:

./goMarkableStream install

This will create the service file and enable it to start automatically on boot. You can change the settings by editing /home/root/.config/goMarkableStream/env

Alternatively, you can manually create the service file after connecting via USB-C (ssh [email protected]):

cat  /etc/systemd/system/goMarkableStream.service
[Unit]
Description=goMarkableStream Server

[Service]
ExecStart=/home/root/goMarkableStream
Restart=always

[Install]
WantedBy=multi-user.target
EOF

systemctl daemon-reload
systemctl enable --now goMarkableStream.service

To check status: systemctl status goMarkableStream.service

To view logs: journalctl -u goMarkableStream.service

To stop: systemctl stop goMarkableStream.service

Note: After a reMarkable system update, you may need to re-download the binary and restart the service.

Subcommands

goMarkableStream provides built-in subcommands to simplify installation and updates:

install

Installs goMarkableStream as a systemd service for automatic startup:

./goMarkableStream install

This command:

• Creates the systemd service file at /etc/systemd/system/goMarkableStream.service
• Reloads the systemd daemon
• Enables and starts the service

download

Downloads the latest version from GitHub releases:

./goMarkableStream download

This command:

1. Computes the SHA256 checksum of the currently running binary
2. Fetches the latest release from GitHub
3. Compares the current checksum against all binaries in the release
4. If you're already running the latest version, it tells you
5. If a newer version is available, prompts you to confirm the download
6. Lists all available binaries and lets you choose which one to download
7. Downloads and verifies the checksum of the selected binary
8. Asks if you want to replace the current binary with the downloaded one

This is the recommended way to update goMarkableStream on your device.

Configurations

Device Configuration

Configure the application via environment variables:

• RK_SERVER_BIND_ADDR: (String, default: :2001) Server bind address.
• RK_SERVER_USERNAME: (String, default: admin) Username for server access.
• RK_SERVER_PASSWORD: (String, default: password) Password for server access.
• RK_HTTPS: (True/False, default: true) Enable or disable HTTPS.
• RK_DEV_MODE: (True/False, default: false) Enable or disable developer mode.
• RK_DELTA_THRESHOLD: (Float, default: 0.30) Change ratio threshold (0.0-1.0) above which a full frame is sent instead of delta.

Tailscale Configuration

Tailscale allows secure remote access to your reMarkable tablet from anywhere on your tailnet, without exposing the device to the public internet. When enabled, goMarkableStream creates both a local listener (on RK_SERVER_BIND_ADDR) and a Tailscale listener.

Requirements:

• Build with the tailscale tag: go build -tags tailscale
• A Tailscale account

Environment variables:

• RK_TAILSCALE_ENABLED: (True/False, default: false) Enable Tailscale listener.
• RK_TAILSCALE_PORT: (String, default: :8443) Tailscale listener port.
• RK_TAILSCALE_HOSTNAME: (String, default: gomarkablestream) Device name in your tailnet.
• RK_TAILSCALE_STATE_DIR: (String, default: /home/root/.tailscale/gomarkablestream) State directory for Tailscale.
• RK_TAILSCALE_AUTHKEY: (String, default: empty) Auth key for headless setup. If unset, Tailscale will display a login URL in the console for interactive authentication.
• RK_TAILSCALE_EPHEMERAL: (True/False, default: false) Register as ephemeral node (removed when disconnected). Recommended for most users. When enabled, a random suffix is appended to the hostname (e.g., gomarkablestream-a1b2c3) to avoid naming conflicts if multiple instances are started.
• RK_TAILSCALE_FUNNEL: (True/False, default: false) Enable public internet access via Tailscale Funnel.
• RK_TAILSCALE_USE_TLS: (True/False, default: false) Use Tailscale's automatic TLS certificates.
• RK_TAILSCALE_VERBOSE: (True/False, default: false) Verbose Tailscale logging.

Example usage:

# Enable Tailscale with interactive login (displays login URL in console)
RK_TAILSCALE_ENABLED=true ./goMarkableStream

# Enable Tailscale with auth key (headless setup)
RK_TAILSCALE_ENABLED=true RK_TAILSCALE_AUTHKEY=tskey-auth-xxx ./goMarkableStream

# Recommended: ephemeral mode with auth key (node removed on disconnect, random hostname suffix)
RK_TAILSCALE_ENABLED=true RK_TAILSCALE_EPHEMERAL=true RK_TAILSCALE_AUTHKEY=tskey-auth-xxx ./goMarkableStream

# Access via Tailscale: https://gomarkablestream.your-tailnet.ts.net:8443
# Access locally: https://remarkable.local.:2001

Systemd service with Tailscale:

Add the environment variables to your systemd service file:

[Service]
Environment="RK_TAILSCALE_ENABLED=true"
Environment="RK_TAILSCALE_AUTHKEY=tskey-auth-xxx"
ExecStart=/home/root/goMarkableStream

Endpoint Configuration

Add query parameters to the URL (?parameter=value&otherparameter=value):

• color: (true/false) Enable or disable color.
• portrait: (true/false) Enable or disable portrait mode.
• rate: (integer, 100-...) Set the frame rate.
• flip: (true/false) Enable or disable flipping 180 degrees.

API Endpoints

• /: Main web interface
• /stream: The image data stream
• /events: WebSocket endpoint for pen input events
• /gestures: Endpoint for touch events
• /version: Returns the current version of goMarkableStream

Presentation Mode

goMarkableStream introduces an innovative experimental feature that allows users to set a presentation or video in the background, enabling live annotations using a reMarkable tablet. This feature is ideal for enhancing presentations or educational content by allowing dynamic, real-time interaction.

How It Works

• To use this feature, append ?present=https://url-of-the-embedded-file to your streaming URL.
• This action will embed your chosen presentation or video in the stream's background.
• You can then annotate or draw on the reMarkable tablet, with your input appearing over the embedded content in the stream.