{"id":13464584,"url":"https://github.com/novnc/websockify","last_synced_at":"2025-12-16T13:49:23.711Z","repository":{"id":1305891,"uuid":"1248263","full_name":"novnc/websockify","owner":"novnc","description":"Websockify is a WebSocket to TCP proxy/bridge. This allows a browser to connect  to any application/server/service.","archived":false,"fork":false,"pushed_at":"2025-10-16T11:05:54.000Z","size":4795,"stargazers_count":4270,"open_issues_count":42,"forks_count":837,"subscribers_count":135,"default_branch":"master","last_synced_at":"2025-12-11T17:22:09.134Z","etag":null,"topics":["bridge","certificate","javascript","novnc","proxy","python","ssl","subprotocol","traffic","websocket-protocol","websocket-proxy","websockets","websockify","wss"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/novnc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.txt","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2011-01-12T22:51:17.000Z","updated_at":"2025-12-11T13:23:14.000Z","dependencies_parsed_at":"2023-02-12T03:30:53.339Z","dependency_job_id":"f149abea-9441-49b0-ab7c-cc98688b04ea","html_url":"https://github.com/novnc/websockify","commit_stats":{"total_commits":797,"total_committers":94,"mean_commits":8.47872340425532,"dds":0.3764115432873275,"last_synced_commit":"a1346552fbed8445c4d27bb8b10542663d37c569"},"previous_names":["kanaka/websockify"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/novnc/websockify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novnc%2Fwebsockify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novnc%2Fwebsockify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novnc%2Fwebsockify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novnc%2Fwebsockify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/novnc","download_url":"https://codeload.github.com/novnc/websockify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novnc%2Fwebsockify/sbom","scorecard":{"id":549075,"data":{"date":"2025-08-11","repo":{"name":"github.com/novnc/websockify","commit":"a02143ce85a21f6093e24d844a3ca68dcb12fb68"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.1,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":8,"reason":"Found 5/6 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/lint.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: COPYING:0","Info: FSF or OSI recognized license: GNU Lesser General Public License v3.0: COPYING:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/novnc/websockify/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/novnc/websockify/test.yml/master?enable=pin","Warn: containerImage not pinned by hash: docker/Dockerfile:1: pin your Docker image by updating python to python@sha256:3b2f1b9c9948e9dc96e1a2f4668ba9870ff43ab834f91155697476142b3bc299","Warn: pipCommand not pinned by hash: docker/Dockerfile:5","Warn: pipCommand not pinned by hash: .github/workflows/lint.yml:12","Warn: pipCommand not pinned by hash: .github/workflows/lint.yml:13","Warn: pipCommand not pinned by hash: .github/workflows/lint.yml:16","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:26","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:27","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:34","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   9 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'","Warn: branch protection not enabled for branch 'patches'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T10:18:01.285Z","repository_id":1305891,"created_at":"2025-08-20T10:18:01.285Z","updated_at":"2025-08-20T10:18:01.285Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27675875,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-12T02:00:06.775Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bridge","certificate","javascript","novnc","proxy","python","ssl","subprotocol","traffic","websocket-protocol","websocket-proxy","websockets","websockify","wss"],"created_at":"2024-07-31T14:00:46.685Z","updated_at":"2025-12-16T13:49:23.674Z","avatar_url":"https://github.com/novnc.png","language":"Python","funding_links":[],"categories":["Python","Websocket Utilities","\u003ca id=\"d03d494700077f6a65092985c06bf8e8\"\u003e\u003c/a\u003e工具","Tool"],"sub_categories":["\u003ca id=\"0ff94312f3ab4898f5996725133ea9d1\"\u003e\u003c/a\u003e未分类"],"readme":"## websockify: WebSockets support for any application/server\n\nwebsockify was formerly named wsproxy and was part of the\n[noVNC](https://github.com/novnc/noVNC) project.\n\nAt the most basic level, websockify just translates WebSockets traffic\nto normal socket traffic. Websockify accepts the WebSockets handshake,\nparses it, and then begins forwarding traffic between the client and\nthe target in both directions.\n\n### News/help/contact\n\nNotable commits, announcements and news are posted to\n\u003ca href=\"http://www.twitter.com/noVNC\"\u003e@noVNC\u003c/a\u003e\n\nIf you are a websockify developer/integrator/user (or want to be)\nplease join the \u003ca\nhref=\"https://groups.google.com/forum/?fromgroups#!forum/novnc\"\u003enoVNC/websockify\ndiscussion group\u003c/a\u003e\n\nBugs and feature requests can be submitted via [github\nissues](https://github.com/novnc/websockify/issues).\n\nIf you want to show appreciation for websockify you could donate to a great\nnon-profits such as: [Compassion\nInternational](http://www.compassion.com/), [SIL](http://www.sil.org),\n[Habitat for Humanity](http://www.habitat.org), [Electronic Frontier\nFoundation](https://www.eff.org/), [Against Malaria\nFoundation](http://www.againstmalaria.com/), [Nothing But\nNets](http://www.nothingbutnets.net/), etc. Please tweet \u003ca\nhref=\"http://www.twitter.com/noVNC\"\u003e@noVNC\u003c/a\u003e if you do.\n\n### WebSockets binary data\n\nStarting with websockify 0.5.0, only the HyBi / IETF\n6455 WebSocket protocol is supported. There is no support for the older\nBase64 encoded data format.\n\n\n### Encrypted WebSocket connections (wss://)\n\nTo encrypt the traffic using the WebSocket 'wss://' URI scheme you need to\ngenerate a certificate and key for Websockify to load. By default, Websockify\nloads a certificate file name `self.pem` but the `--cert=CERT` and `--key=KEY`\noptions can override the file name. You can generate a self-signed certificate\nusing openssl. When asked for the common name, use the hostname of the server\nwhere the proxy will be running:\n\n```\nopenssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem\n```\n\nFor a self-signed certificate to work, you need to make your client/browser\nunderstand it. You can do this by installing it as accepted certificate, or by\nusing that same certificate for a HTTPS connection to which you navigate first\nand approve. Browsers generally don't give you the \"trust certificate?\" prompt\nby opening a WSS socket with invalid certificate, hence you need to have it\naccept it by either of those two methods. \n\nThe ports may be considered as distinguishing connections by the browser,\nfor example, if your website url is https://my.local:8443 and your WebSocket \nurl is wss://my.local:8001, first browse to https://my.local:8001, add the \nexception, then browse to https://my.local:8443 and add another exception.\nThen an html page served over :8443 will be able to open WSS to :8001\n\nIf you have a commercial/valid SSL certificate with one or more intermediate\ncertificates, concat them into one file, server certificate first, then the\nintermediate(s) from the CA, etc. Point to this file with the `--cert` option\nand then also to the key with `--key`. Finally, use `--ssl-only` as needed.\n\n\n### Additional websockify features\n\nThese are not necessary for the basic operation.\n\n* Daemonizing: When the `-D` option is specified, websockify runs\n  in the background as a daemon process.\n\n* SSL (the wss:// WebSockets URI): This is detected automatically by\n  websockify by sniffing the first byte sent from the client and then\n  wrapping the socket if the data starts with '\\x16' or '\\x80'\n  (indicating SSL).\n\n* Session recording: This feature that allows recording of the traffic\n  sent and received from the client to a file using the `--record`\n  option.\n\n* Mini-webserver: websockify can detect and respond to normal web\n  requests on the same port as the WebSockets proxy. This functionality\n  is activated with the `--web DIR` option where DIR is the root of the\n  web directory to serve.\n\n* Wrap a program: see the \"Wrap a Program\" section below.\n\n* Log files: websockify can save all logging information in a file.\n  This functionality is activated with the `--log-file FILE` option\n  where FILE is the file where the logs should be saved.\n\n* Authentication plugins: websockify can demand authentication for\n  websocket connections and, if you use `--web-auth`, also for normal\n  web requests. This functionality is activated with the\n  `--auth-plugin CLASS` and `--auth-source ARG` options, where CLASS is\n  usually one from auth_plugins.py and ARG is the plugin's configuration.\n\n* Token plugins: a single instance of websockify can connect clients to\n  multiple different pre-configured targets, depending on the token sent\n  by the client using the `token` URL parameter, or the hostname used to\n  reach websockify, if you use `--host-token`. This functionality is\n  activated with the `--token-plugin CLASS` and `--token-source ARG`\n  options, where CLASS is usually one from token_plugins.py and ARG is\n  the plugin's configuration.\n\n### Other implementations of websockify\n\nThe primary implementation of websockify is in python. There are\nseveral alternate implementations in other languages available in\nour sister repositories [websockify-js](https://github.com/novnc/websockify-js)\n(JavaScript/Node.js) and [websockify-other](https://github.com/novnc/websockify-other)\n (C, Clojure, Ruby).\n\nIn addition there are several other external projects that implement\nthe websockify \"protocol\". See the alternate implementation [Feature\nMatrix](https://github.com/novnc/websockify/wiki/Feature_Matrix) for\nmore information.\n\n\n### Wrap a Program\n\nIn addition to proxying from a source address to a target address\n(which may be on a different system), websockify has the ability to\nlaunch a program on the local system and proxy WebSockets traffic to\na normal TCP port owned/bound by the program.\n\nThis is accomplished by the LD_PRELOAD library (`rebind.so`)\nwhich intercepts bind() system calls by the program. The specified\nport is moved to a new localhost/loopback free high port. websockify\nthen proxies WebSockets traffic directed to the original port to the\nnew (moved) port of the program.\n\nThe program wrap mode is invoked by replacing the target with `--`\nfollowed by the program command line to wrap.\n\n    `./run 2023 -- PROGRAM ARGS`\n\nThe `--wrap-mode` option can be used to indicate what action to take\nwhen the wrapped program exits or daemonizes.\n\nHere is an example of using websockify to wrap the vncserver command\n(which backgrounds itself) for use with\n[noVNC](https://github.com/novnc/noVNC):\n\n    `./run 5901 --wrap-mode=ignore -- vncserver -geometry 1024x768 :1`\n\nHere is an example of wrapping telnetd (from krb5-telnetd). telnetd\nexits after the connection closes so the wrap mode is set to respawn\nthe command:\n\n    `sudo ./run 2023 --wrap-mode=respawn -- telnetd -debug 2023`\n\nThe `wstelnet.html` page in the [websockify-js](https://github.com/novnc/websockify-js)\nproject demonstrates a simple WebSockets based telnet client (use\n'localhost' and '2023' for the host and port respectively).\n\n\n### Installing websockify\n\nDownload one of the releases or the latest development version, extract\nit and run `python3 setup.py install` as root in the directory where you\nextracted the files. Normally, this will also install numpy for better\nperformance, if you don't have it installed already. However, numpy is\noptional. If you don't want to install numpy or if you can't compile it,\nyou can edit setup.py and remove the `install_requires=['numpy'],` line\nbefore running `python3 setup.py install`.\n\nAfterwards, websockify should be available in your path. Run\n`websockify --help` to confirm it's installed correctly.\n\n\n### Running with Docker/Podman\nYou can also run websockify using Docker, Podman, Singularity, udocker or\nyour favourite container runtime that support OCI container images.\n\nThe entrypoint of the image is the `run` command.\n\nTo build the image:\n```\n./docker/build.sh\n```\n\nOnce built you can just launch it with the same\narguments you would give to the `run` command and taking care of\nassigning the port mappings:\n```\ndocker run -it --rm -p \u003cport\u003e:\u003ccontainer_port\u003e novnc/websockify \u003ccontainer_port\u003e \u003crun_arguments\u003e\n```\n\nFor example to forward traffic from local port 7000 to 10.1.1.1:5902\nyou can use:\n```\ndocker run -it --rm -p 7000:80 novnc/websockify 80 10.1.1.1:5902\n```\n\nIf you need to include files, like for example for the `--web` or `--cert`\noptions you can just mount the required files in the `/data` volume and then\nyou can reference them in the usual way:\n```\ndocker run -it --rm -p 443:443 -v websockify-data:/data novnc/websockify --cert /data/self.pem --web /data/noVNC :443 --token-plugin TokenRedis --token-source myredis.local:6379 --ssl-only --ssl-version tlsv1_2\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovnc%2Fwebsockify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnovnc%2Fwebsockify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovnc%2Fwebsockify/lists"}