# 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](https://github.com/imegeek/noVNC/blob/master/LICENSE). See the LICENSE file for details.
## Acknowledgments
* [noVNC](https://github.com/novnc/noVNC) - Open source VNC client using HTML5 and WebSockets
* [websockify](https://github.com/novnc/websockify) - WebSockets support for any application
Raw data
{
"_id": null,
"home_page": null,
"name": "novnc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, novnc, vnc, web",
"author": "Im Geek (Ankush Bhagat)",
"author_email": "<imegeek@gmail.com>",
"download_url": null,
"platform": null,
"description": "\r\n# noVNC\r\n\r\n\r\n\r\nnoVNC 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.\r\n\r\n\r\n\r\n## Features\r\n\r\n\r\n\r\n* **Easy Setup** : Quickly integrate your VNC server and access it via a web browser.\r\n\r\n* **Web-based Access** : No need for a standalone VNC client; everything runs in the browser.\r\n\r\n* **Secure Connection** : Uses websockify to securely proxy WebSocket connections to the VNC server.\r\n\r\n\r\n\r\n## Requirements\r\n\r\n\r\n\r\n* Python 3.x\r\n\r\n* VNC server (e.g., TigerVNC, TightVNC)\r\n\r\n\r\n\r\n## Installation\r\n\r\n\r\n\r\nInstall via pip:\r\n\r\n\r\n\r\n```\r\n\r\npip install novnc\r\n\r\n```\r\n\r\n\r\n\r\nManual Installation:\r\n\r\n\r\n\r\nTo install Terminal Widgets locally, follow these steps:\r\n\r\n\r\n\r\n1. Clone this repository to your local machine. `git clone https://github.com/imegeek/noVNC`\r\n\r\n2. Navigate to the cloned directory. `cd noVNC`\r\n\r\n3. Install the package using pip: `pip install .` or `pip3 install .`\r\n\r\n\r\n\r\nThis will install noVNC along with its dependencies from the local source files.\r\n\r\n\r\n\r\n## Options\r\n\r\n\r\n\r\n* `--listen HOST:PORT`: Sets the proxy/webserver IP address and port to listen. Default is `http://[::]:5800`.\r\n\r\n* `--target HOST:PORT`: Sets the VNC IP address and port to target.\r\n\r\n\r\n\r\n## Usage\r\n\r\n\r\n\r\nStart the server by running the module:\r\n\r\n\r\n\r\n```\r\n\r\nnovnc --listen <HOST:PORT> --target <VNC_SERVER_IP>:<VNC_SERVER_PORT> \r\n\r\n```\r\n\r\n\r\n\r\n## Example\r\n\r\n\r\n\r\n```\r\n\r\nnovnc --listen 0.0.0.0:8080 --target 127.0.0.1:5900\r\n\r\n```\r\n\r\n\r\n\r\nNow server will listens on `0.0.0.0:8080` and targets the VNC server at `127.0.0.1:5900`.\r\n\r\n\r\n\r\n## Configuration\r\n\r\n\r\n\r\nTo customize the program's behavior, you can use the --listen and --target options when running the executable.\r\n\r\n\r\n\r\n## Troubleshooting\r\n\r\n\r\n\r\n* **Connection Issues** : Ensure the VNC server is running and accessible. Verify the IP and port.\r\n\r\n\r\n\r\n## License\r\n\r\n\r\n\r\nThis program is licensed under the [MIT License](https://github.com/imegeek/noVNC/blob/master/LICENSE). See the LICENSE file for details.\r\n\r\n\r\n\r\n## Acknowledgments\r\n\r\n\r\n\r\n* [noVNC](https://github.com/novnc/noVNC) - Open source VNC client using HTML5 and WebSockets\r\n\r\n* [websockify](https://github.com/novnc/websockify) - WebSockets support for any application\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "1.0.1",
"project_urls": null,
"split_keywords": [
"python",
" novnc",
" vnc",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3094953f892a9a6c71e052a88ac51c47592ccc2b86bffe5426c06a6c049d38cb",
"md5": "ee0e01710498ccfe46eb1ac3b725b422",
"sha256": "9bc20158d8f6f20b43467942db20dc3e3ddb29b44b871607edf69b2cafe13032"
},
"downloads": -1,
"filename": "novnc-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee0e01710498ccfe46eb1ac3b725b422",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11836071,
"upload_time": "2024-05-18T09:00:58",
"upload_time_iso_8601": "2024-05-18T09:00:58.007583Z",
"url": "https://files.pythonhosted.org/packages/30/94/953f892a9a6c71e052a88ac51c47592ccc2b86bffe5426c06a6c049d38cb/novnc-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-18 09:00:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "novnc"
}
JSON