{"id":46451536,"url":"https://github.com/openmcp-project/ui-backend","last_synced_at":"2026-03-06T00:32:05.673Z","repository":{"id":285713557,"uuid":"926635600","full_name":"openmcp-project/ui-backend","owner":"openmcp-project","description":"UI backend for @openmcp-project","archived":false,"fork":false,"pushed_at":"2026-03-01T08:03:05.000Z","size":72,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2026-03-01T11:13:30.442Z","etag":null,"topics":["apeirora","backend","openmcp","ui"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openmcp-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-03T15:54:31.000Z","updated_at":"2025-11-25T17:42:00.000Z","dependencies_parsed_at":"2025-04-02T09:36:09.629Z","dependency_job_id":"fef22cd5-134b-4668-85c3-34fd0510a0d3","html_url":"https://github.com/openmcp-project/ui-backend","commit_stats":null,"previous_names":["openmcp-project/ui-backend"],"tags_count":7,"template":false,"template_full_name":"openmcp-project/repository-template","purl":"pkg:github/openmcp-project/ui-backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmcp-project%2Fui-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmcp-project%2Fui-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmcp-project%2Fui-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmcp-project%2Fui-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openmcp-project","download_url":"https://codeload.github.com/openmcp-project/ui-backend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmcp-project%2Fui-backend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30156286,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T22:39:40.138Z","status":"ssl_error","status_checked_at":"2026-03-05T22:39:24.771Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["apeirora","backend","openmcp","ui"],"created_at":"2026-03-06T00:32:05.023Z","updated_at":"2026-03-06T00:32:05.649Z","avatar_url":"https://github.com/openmcp-project.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ui-backend\n\n[![REUSE status](https://api.reuse.software/badge/github.com/openmcp-project/ui-backend)](https://api.reuse.software/info/github.com/openmcp-project/ui-backend)\n\n## About this project\n\nThis is the backend for our [MCP UI](https://github.com/openmcp-project/ui-frontend).\nIts a simple proxy server which sits between the UI frontend and the Kubernetes API server.\n\n### Motivation\n\nWe want to call the kubernetes api server directly from the browser, but we have several problems preventing us from calling the api from the browser:\n\n- TLS certificate is not signed from a well-known CA\n- CORS is not configured most of the time\n\n### Solution\n\nThe `ui-backend` server acts like a proxy when talking to the Crate-Cluster or MCPs from the browser.\nThe browser sends the request to the `ui-backend`, with authorization data and optionally the project, workspace and controlplane name of the MCP in header data.\n\n- If requesting the Crate: The request will get send to the crate cluster with the authorization data in the headers\n- If requesting an MCP: The `ui-backend` will call the Crate to get the `kubeconfig` of the MCP and then calls the MCP with that kubeconfig\n\nThere are only some modifications done when piping the request to the api server, preventing some headers from going through.\n\n## Requirements and Setup\n\nYou need to have a running mcp landscape. Then reference the KUBECONFIG for the backend using the `KUBECONFIG` environment variable.\n\nThe backend can be started using:\n\n```bash\ngo run cmd/server/main.go\n```\n\n## Usage\n\nYou can reach the backend on port `3000` and the path as you would directly to the api server.\n\n```txt\nFor example: http://localhost:3000/api/v1/namespaces\n```\n\nPut the authorization data in the following headers:\n\n- `X-Client-Certificate-Data`\n- `X-Client-Key-Data`\n\nor (for OIDC):\n\n- `Authorization: \u003ctoken\u003e`\n\nAlso configure the api-server you want to call:\n\n- Crate: Add the header `X-Use-Crate-Cluster: true`\n- MCP: Add the headers `X-Project-Name`, `X-Workspace-Name` and `X-Control-Plane-Name`\n\n### Parsing JSON\n\n`ui-backend` support jsonpath (kubectl version) and jq (gojq) to parse json before sending it to the client, reducing the data transfered to the client.\n\nUsage:\n\n- JsonPath: Add a header `X-jsonpath` with the jsonpath query\n- JQ: Add a header `X-jq` with the jq query\n\n## Support, Feedback, Contributing\n\nThis project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/openmcp-project/ui-backend/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).\n\n## Security / Disclosure\n\nIf you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/openmcp-project/ui-backend/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.\n\n## Code of Conduct\n\nWe as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.\n\n## Licensing\n\nCopyright 2025 SAP SE or an SAP affiliate company and ui-backend contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/openmcp-project/ui-backend).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmcp-project%2Fui-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenmcp-project%2Fui-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmcp-project%2Fui-backend/lists"}