# uvnc-repeater > The UltraVNC Repeater implementation in NodeJS Latest version **1.5.4** (published 2026-07-24) · MIT license · 0 weekly downloads ## Install ```sh npm install uvnc-repeater pnpm add uvnc-repeater yarn add uvnc-repeater bun add uvnc-repeater ``` Provides the command `uvnc-repeater`. ## Health **Score 65/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 1.5.4 | | Published | 2026-07-24 | | First published | 2023-09-18 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=18.0.0 | | Dependencies | 4 | | Unpacked size | 274.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 5 | | Author | Tomáš Dvořák | | Maintainers | tomas2d | | Keywords | ultravnc repeater, ultravnc, uvnc | ## Links - npm: https://www.npmjs.com/package/uvnc-repeater - Repository: https://github.com/Tomas2D/uvnc-repeater - Homepage: https://github.com/Tomas2D/uvnc-repeater#readme - Issues: https://github.com/Tomas2D/uvnc-repeater/issues - npm.io page: https://npm.io/package/uvnc-repeater ## Dependencies (4) - [pino](https://npm.io/package/pino.md) ^9.6.0 - [yargs](https://npm.io/package/yargs.md) ^17.7.2 - [pino-pretty](https://npm.io/package/pino-pretty.md) ^13.1.3 - [net-keepalive](https://npm.io/package/net-keepalive.md) ^4.0.25 ## Recent versions - 1.5.4 (latest) — 2026-07-24 - 1.5.3 — 2024-07-24 - 1.5.2 — 2024-07-23 - 1.5.1 — 2024-07-22 - 1.5.0 — 2024-07-20 - 1.4.6 — 2024-05-22 - 1.4.5 — 2024-05-11 - 1.4.3 — 2024-05-07 - 1.4.1 — 2024-03-16 - 1.4.0 — 2023-12-11 - 1.2.0 — 2023-09-24 - 1.2.0-beta — 2023-09-20 - 1.2.0-alpha — 2023-09-19 - 1.1.0 — 2023-09-18 - 1.0.1 — 2023-09-18 ## README # 💻 🔄 uvnc-repeater (UltraVNC Repeater) UltraVNC Repeater Implementation in Node.js, for use as a library within a larger application or as a standalone CLI tool. This library draws inspiration from the [Perl implementation](https://github.com/tomka/ultravnc-repeater/). Show some love and ⭐️ this project! ## Library ### Installation ```shell yarn add uvnc-repeater ``` ```shell npm install uvnc-repeater ``` ```typescript // CommonJS const { UltraVNCRepeater } = require("uvnc-repeater"); // ESM / Typescript import { UltraVNCRepeater } from "uvnc-repeater"; ``` ## Examples **Minimal working setup** ```typescript import { UltraVNCRepeater } from "uvnc-repeater"; const repeater = new UltraVNCRepeater(); // The server gateway will be started on port 5500. // The client gateway will be started on port 5900. await repeater.start(); // Get active connections (both client and server are defined) const activeConnections = repeater.getActiveConnections(); // Get pending connections (either client or server will be defined) const pendingConnections = repeater.getPendingConnections(); // Close repeater (pass true as first parameter to force shutdown) await repeater.stop(); ``` **Custom settings** ```typescript import { UltraVNCRepeater } from "uvnc-repeater"; const repeater = new UltraVNCRepeater({ serverPort: 5500, clientPort: 5900, // Reads and waits for the first N bytes from an incoming connection. // In this data chunk, the target ID or 'host:port' should be contained. bufferSize: 250, // Timeout (seconds) in which we should gather `bufferSize` bytes from the connection socket socketFirstDataTimeout: 60 * 5, // Prevent direct connecting to the target when 'host:port' is sent instead of ID. refuseDirectHookup: false, // Prevents multiple connections to the same target, instead override the existing connection. refuse: false, // Does not send "RFB 000.000" to the client when the connection starts. noRFB: false, // Specify a custom path for logging (default is standard output). logFile: "/tmp/repeater.log", // Log levels: "info", "debug", "fatal", "warn", "trace", "error", "warn", "silent". logLevel: "debug", // Timeout in seconds (in case of inactivity) for all connections.` socketTimeout: 60 * 5, // Keep-Alive interval in seconds keepAlive: 30, // Keep-Alive maximal retries before connection is closed keepAliveRetries: 1, // Time in seconds for a graceful shutdown (close() method or on SIGTERM/SIGINT signal). // pass Infinity (Number.POSITIVE_INFINITY) to disable such a feature killTimeout: 30, }); await repeater.start(); // ... // ... await repeater.stop(); ``` **Custom logger** ```typescript import { UltraVNCRepeater, createLogger, createFileLogger, // for files } from "uvnc-repeater"; const repeater = new UltraVNCRepeater({ logger: createLogger({ /* custom options for a pino logger */ }), }); await repeater.start(); ``` **Custom logic** If you want to extend the repeater functionality, you can extend the `UltraVNCRepeater` class and override some of its methods. ```typescript import { UltraVNCRepeater, NewClientConnectionEvent, NewServerConnectionEvent, CloseConnectionEvent, } from "uvnc-repeater"; import { Socket } from "node:net"; class MyRepeater extends UltraVNCRepeater { constructor(options: Partial) { super(options); } protected async _onNewClient(event: NewClientConnectionEvent): Promise { await super._onNewClient(event); // do something } protected async _onCloseClient(event: CloseConnectionEvent): Promise { await super._onCloseClient(event); // do something } protected async _onNewServer(event: NewServerConnectionEvent): Promise { return super._onNewServer(event); // do something } protected async _onCloseServer(event: CloseConnectionEvent): Promise { await super._onCloseServer(event); // do something } } const repeater = new MyRepeater({ level: "debug", }); await repeater.start(); // ... // ... await repeater.stop(); ``` ### Events Because the core class `UltraVNCRepeater` extends the Node.js `EventEmitter`, one can listen for the following events. ```typescript import { Event } from "uvnc-repeater"; // Repeater Event.BEFORE_REPEATER_START; Event.AFTER_REPEATER_START; Event.BEFORE_REPEATER_STOP; Event.AFTER_REPEATER_STOP; // Repeater - server Event.BEFORE_SERVER_GATEWAY_START; Event.AFTER_SERVER_GATEWAY_START; Event.BEFORE_SERVER_GATEWAY_STOP; Event.AFTER_SERVER_GATEWAY_STOP; // Repeater - client Event.BEFORE_CLIENT_GATEWAY_START; Event.AFTER_CLIENT_GATEWAY_START; Event.BEFORE_CLIENT_GATEWAY_STOP; Event.AFTER_CLIENT_GATEWAY_STOP; // Server Event.BEFORE_SERVER_CLOSE; Event.AFTER_SERVER_CLOSE; Event.BEFORE_SERVER_NEW; Event.SERVER_NEW_ADDED_TO_PENDING; Event.SERVER_NEW_PREVENT_HOOKUP; Event.SERVER_NEW_HOOKUP; Event.SERVER_NEW_OVERRIDE_OLD; // Client Event.BEFORE_CLIENT_NEW; Event.CLIENT_NEW_HOOKUP_DIRECT; Event.BEFORE_CLIENT_CLOSE; Event.AFTER_CLIENT_CLOSE; Event.CLIENT_NEW_ADDED_TO_PENDING; Event.CLIENT_NEW_DIRECT_INVALID_PORT; Event.CLIENT_NEW_DIRECT_INVALID_HOST; Event.CLIENT_NEW_HOOKUP; Event.CLIENT_NEW_PREVENT_HOOKUP; Event.CLIENT_NEW_OVERRIDE_OLD; ``` **Example** ```typescript import { UltraVNCRepeater, Event } from "uvnc-repeater"; const repeater = new UltraVNCRepeater(); repeater.on(Event.CLIENT_NEW_ADDED_TO_PENDING, (event) => { console.log(`Client with ID: ${event.id} is waiting for the server.`); }); await repeater.start(); ``` **Manual Connection Closing** ```typescript import {UltraVNCRepeater, Event} from "uvnc-repeater"; import {createConnection} from "net"; const repeater = new UltraVNCRepeater(); await repeater.start(); // ... after a while const activeConnections = repeater.getActiveConnections() for (const [internalId, connection] of activeConnections) { if (connection.id === "10000") { await repeater.closeConnection(connection) } } const pendingConnections = repeater.getPendingConnections() if (pendingConnections.has("10000")) { const connection = pendingConnections.get("10000") await repeater.closeConnection(connection) } ``` ## ⌨️ CLI If you want to use the repeater as is, you can install it as a CLI tool. ### Global Installation ```shell yarn global add uvnc-repeater ``` ```shell npm install -g uvnc-repeater ``` ### Commands **Show Help** ```shell uvnc-repeater --help ``` **Start Repeater** ```shell uvnc-repeater ``` **Start Repeater with Custom Options** ```shell uvnc-repeater --serverPort 5555 ``` Or use environmental variables (or both) to set custom options. ```shell REPEATER_SERVER_PORT=5555 uvnc-repeater ``` To list all possible options, see help (`uvnc-repeater --help`) ### 📃 TODO - [ ] Tests --- _Source: https://npm.io/package/uvnc-repeater · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._