{"id":13549000,"url":"https://github.com/changkun/occamy","last_synced_at":"2025-07-27T06:34:41.388Z","repository":{"id":45390420,"uuid":"166392711","full_name":"changkun/occamy","owner":"changkun","description":"🖥️ a modern remote desktop proxy written in Go","archived":false,"fork":false,"pushed_at":"2021-12-16T08:31:34.000Z","size":9239,"stargazers_count":319,"open_issues_count":8,"forks_count":53,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-31T14:15:39.985Z","etag":null,"topics":["go","golang","guacamole","proxy","rdp","remote-desktop-protocol","ssh","vnc","websocket"],"latest_commit_sha":null,"homepage":"https://github.com/changkun/occamy","language":"Go","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/changkun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["changkun"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-01-18T11:10:22.000Z","updated_at":"2025-03-27T14:22:48.000Z","dependencies_parsed_at":"2022-08-28T15:11:01.968Z","dependency_job_id":null,"html_url":"https://github.com/changkun/occamy","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changkun%2Foccamy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changkun%2Foccamy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changkun%2Foccamy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changkun%2Foccamy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/changkun","download_url":"https://codeload.github.com/changkun/occamy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247694876,"owners_count":20980733,"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","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":["go","golang","guacamole","proxy","rdp","remote-desktop-protocol","ssh","vnc","websocket"],"created_at":"2024-08-01T12:01:17.117Z","updated_at":"2025-04-07T17:09:02.520Z","avatar_url":"https://github.com/changkun.png","language":"Go","funding_links":["https://github.com/sponsors/changkun"],"categories":["Go"],"sub_categories":[],"readme":"\u003cimg src=\"./docs/occamy.png\" alt=\"logo\" height=\"150\" align=\"right\" /\u003e\n\n# Occamy\n\n[![Latest relsease](https://img.shields.io/github/v/tag/changkun/occamy?label=latest)](https://github.com/changkun/occamy/releases)\n[![Build Status](https://github.com/changkun/occamy/workflows/Builds/badge.svg)](https://github.com/changkun/occamy/actions)\n[![Go Report Card](https://goreportcard.com/badge/github.com/changkun/occamy)](https://goreportcard.com/report/github.com/changkun/occamy)\n\nOccamy is an open source protocol and proxy for modern remote desktop control that written in Go.\n\n## To start using Occamy\n\n### Build\n\nOccamy support deployment with Docker or container orchestration tool, e.g. K8s. \nTo build Occamy, you need:\n\n```\ngit clone https://github.com/changkun/occamy.git\ncd occamy\nmake build\n```\n\nThen you should be able to run occamy with:\n\n```\ndocker run -itd occamy:latest\n```\n\n### APIs\n\nOccamy offers two APIs:\n\n- `/api/v1/login` distributes JWT tokens for authentication and\n- `/api/v1/connect` is used for WebSocket based Occamy connection.\n\nIf you build Occamy with web client, you can also access `/static` for web client demo.\n\n### Demo\n\nTo run a demo, you need build an occamy client first:\n\n```\ncd client/occamy-web\nnpm install \u0026\u0026 npm run build\n```\n\nWith docker-compose, you should be able to run a working demo with:\n\n```\nmake build\nmake run\nmake stop\n```\n\nHere is a working video demo:\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://youtu.be/e24WHo4Kpx8\"\u003e\u003cimg src=\"https://img.youtube.com/vi/e24WHo4Kpx8/0.jpg\" alt=\"IMAGE ALT TEXT\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## Contributing\n\nEasiest way to contribute is to provide feedback! We would love to hear \nwhat you like and what you think is missing. PRs are welcome. \nPlease follow the given PR template before you send your pull request.\n\n## Why Occamy and how it works?\n\nOccamy implements a generic remote desktop protocol with modern approaches. \nIt currently performs [Guacamole](https://guacamole.apache.org/) protocol \nand eventually intends to redesign and propose Occamy protocol.\n\nThe benefits of Occamy that differ from Guacamole are:\n\n- Authentication supports\n- Simplified architecture\n- Streaming compression and optimization\n- Modern with Go\n\nOccamy server side currently simplifies Guacamole proxy and \nGuacamole servlet client in a single middleware application. \nAny client that involves Guacamole protocol and uses WebSocket \nfor authentication can directly switch to interact to Occamy \nwithout any changes.\n\nRead more details in [docs](./docs/README.md).\n\n## License\n\n[Occamy](https://github.com/changkun/occamy) | [MIT](./LICENSE) \u0026copy; 2019 [Ou Changkun](https://changkun.de)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchangkun%2Foccamy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchangkun%2Foccamy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchangkun%2Foccamy/lists"}