{"id":20200385,"url":"https://github.com/nickjer/singularity-vncserver","last_synced_at":"2026-03-19T14:31:09.952Z","repository":{"id":70912432,"uuid":"121683414","full_name":"nickjer/singularity-vncserver","owner":"nickjer","description":"VNC Server in a Singularity container","archived":false,"fork":false,"pushed_at":"2018-02-15T21:28:52.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-03T08:45:31.103Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://singularity-hub.org/collections/603","language":"Roff","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nickjer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2018-02-15T21:12:43.000Z","updated_at":"2023-09-07T22:57:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"c386de59-6cfc-401c-9032-5250d4bec6b0","html_url":"https://github.com/nickjer/singularity-vncserver","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nickjer/singularity-vncserver","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fsingularity-vncserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fsingularity-vncserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fsingularity-vncserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fsingularity-vncserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nickjer","download_url":"https://codeload.github.com/nickjer/singularity-vncserver/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickjer%2Fsingularity-vncserver/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271507563,"owners_count":24771825,"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-08-21T02:00:08.990Z","response_time":74,"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":[],"created_at":"2024-11-14T04:43:30.348Z","updated_at":"2026-02-11T05:02:27.266Z","avatar_url":"https://github.com/nickjer.png","language":"Roff","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Singularity VNC Server\n\n[![Singularity Hub](https://www.singularity-hub.org/static/img/hosted-singularity--hub-%23e32929.svg)](https://singularity-hub.org/collections/603)\n[![GitHub License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\nSingularity image for [TurboVNC] with the inclusion of [websockify] for\nconnecting to the VNC server from within your browser using [noVNC].\n\nThis is still a work in progress.\n\n## Build\n\nYou can build a local Singularity image named `singularity-vncserver.simg`\nwith:\n\n```sh\nsudo singularity build singularity-vncserver.simg Singularity\n```\n\n## Deploy\n\nInstead of building it yourself you can download the pre-built image from\n[Singularity Hub](https://www.singularity-hub.org) with:\n\n```sh\nsingularity pull --name singularity-vncserver.simg shub://nickjer/singularity-vncserver\n```\n\n## Run\n\n### vncserver\n\nThe `vncserver` command is launched using the default run command:\n\n```sh\nsingularity run singularity-vncserver.simg\n```\n\nor as an explicit app:\n\n```sh\nsingularity run --app vncserver singularity-vncserver.simg\n```\n\nExample:\n\n```console\n$ singularity run --app vncserver singularity-vncserver.simg\n\nYou will require a password to access your desktops.\n\nPassword:\nVerify:\nWould you like to enter a view-only password (y/n)? n\n\nDesktop 'TurboVNC: dev:1 (nickjer)' started on display dev:1\n\nCreating default startup script /home/nickjer/.vnc/xstartup.turbovnc\nStarting applications specified in /home/nickjer/.vnc/xstartup.turbovnc\nLog file is /home/nickjer/.vnc/dev:1.log\n\n$ singularity run --app vncserver singularity-vncserver.simg -kill :1\nKilling Xvnc process ID 9738\n```\n\n### vncpasswd\n\nThe `vncpasswd` command is launched as an explicit app:\n\n```sh\nsingularity run --app vncpasswd singularity-vncserver.simg\n```\n\nExample:\n\n```console\n$ echo \"mypassword\" | singularity run --app vncpasswd singularity-vncserver.simg -f \u003e vnc_passwd\nWarning: password truncated to the length of 8.\n```\n\n### websockify\n\nIn some cases you may not want to download and install a VNC client on your\nlocal machine. In those cases you can actually use the [noVNC] client which\nruns completely in your browser.\n\nIn order to connect to the VNC server with [noVNC] you will need to enable\n[websockify] which will translate the incoming websocket traffic from [noVNC]\nto normal TCP traffic proxied to the listening VNC server.\n\nThe `websockify` command is launched as an explicit app:\n\n```sh\nsingularity run --app websockify singularity-vncserver.simg\n```\n\nAssuming you started a `vncserver` above listening on port `5901` (display port\n`:1`), you will launch `websockify` on the same machine with:\n\n```console\n$ singularity run --app websockify singularity-vncserver.simg 8000 localhost:5901\nWebSocket server settings:\n  - Listen on :8000\n  - No SSL/TLS support (no cert file)\n  - proxying from :8000 to localhost:5901\n```\n\nThen from your browser using the [noVNC] client, connect to the machine running\nthe VNC server and port `8000`.\n\n**It is recommended you either setup SSL for a secure connection or host it\nfrom behind a reverse proxy with SSL already enabled.**\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.com/nickjer/singularity-vncserver.\n\n## License\n\nThe code is available as open source under the terms of the [MIT License].\n\n[TurboVNC]: https://turbovnc.org/\n[websockify]: https://github.com/novnc/websockify/\n[noVNC]: https://kanaka.github.io/noVNC/\n[MIT License]: http://opensource.org/licenses/MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickjer%2Fsingularity-vncserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickjer%2Fsingularity-vncserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickjer%2Fsingularity-vncserver/lists"}