Skip to main content

No project description provided

Project description

noVNC

noVNC is a Python-based server that comes with included (websockify and noVNC) that utilizes noVNC and websockify to provide a web-based VNC client. This allows users to remotely access and control a desktop environment through their web browser.

Features

  • Easy Setup : Quickly integrate your VNC server and access it via a web browser.

  • Web-based Access : No need for a standalone VNC client; everything runs in the browser.

  • Secure Connection : Uses websockify to securely proxy WebSocket connections to the VNC server.

Requirements

  • Python 3.x

  • VNC server (e.g., TigerVNC, TightVNC)

Installation

Install via pip:


pip install novnc

Manual Installation:

To install Terminal Widgets locally, follow these steps:

  1. Clone this repository to your local machine. git clone https://github.com/imegeek/noVNC

  2. Navigate to the cloned directory. cd noVNC

  3. Install the package using pip: pip install . or pip3 install .

This will install noVNC along with its dependencies from the local source files.

Options

  • --listen HOST:PORT: Sets the proxy/webserver IP address and port to listen. Default is http://[::]:5800.

  • --target HOST:PORT: Sets the VNC IP address and port to target.

Usage

Start the server by running the module:


novnc --listen <HOST:PORT> --target <VNC_SERVER_IP>:<VNC_SERVER_PORT> 

Example


novnc --listen 0.0.0.0:8080 --target 127.0.0.1:5900

Now server will listens on 0.0.0.0:8080 and targets the VNC server at 127.0.0.1:5900.

Configuration

To customize the program's behavior, you can use the --listen and --target options when running the executable.

Troubleshooting

  • Connection Issues : Ensure the VNC server is running and accessible. Verify the IP and port.

License

This program is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

  • noVNC - Open source VNC client using HTML5 and WebSockets

  • websockify - WebSockets support for any application

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

novnc-1.0.1-py3-none-any.whl (11.8 MB view details)

Uploaded Python 3

File details

Details for the file novnc-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: novnc-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.0

File hashes

Hashes for novnc-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9bc20158d8f6f20b43467942db20dc3e3ddb29b44b871607edf69b2cafe13032
MD5 ee0e01710498ccfe46eb1ac3b725b422
BLAKE2b-256 3094953f892a9a6c71e052a88ac51c47592ccc2b86bffe5426c06a6c049d38cb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page