{"id":18408336,"url":"https://github.com/pingcap/tiunimanager-ui","last_synced_at":"2026-03-06T01:01:19.230Z","repository":{"id":36967875,"uuid":"387654465","full_name":"pingcap/tiunimanager-ui","owner":"pingcap","description":"A web UI for TiUniManager","archived":false,"fork":false,"pushed_at":"2026-01-16T09:08:09.000Z","size":2061,"stargazers_count":11,"open_issues_count":35,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-16T23:39:16.573Z","etag":null,"topics":["tidb","tiunimanager","ui"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/pingcap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-07-20T02:56:23.000Z","updated_at":"2025-04-04T04:34:25.000Z","dependencies_parsed_at":"2023-01-17T09:32:34.633Z","dependency_job_id":"77334ab7-7b5f-4dea-aadc-a26105d3fc5d","html_url":"https://github.com/pingcap/tiunimanager-ui","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/pingcap/tiunimanager-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pingcap","download_url":"https://codeload.github.com/pingcap/tiunimanager-ui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pingcap%2Ftiunimanager-ui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30156842,"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":["tidb","tiunimanager","ui"],"created_at":"2024-11-06T03:18:32.067Z","updated_at":"2026-03-06T01:01:19.193Z","avatar_url":"https://github.com/pingcap.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003cimg src=\"./public/img/logo/common.svg\" alt=\"logo\" height=\"80px\"\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n# TiUniManager UI\n\n[![CI](https://github.com/pingcap/tiunimanager-ui/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/pingcap/tiunimanager-ui/actions)\n[![Version](https://img.shields.io/github/v/release/pingcap/tiunimanager-ui?color=green\u0026include_prereleases\u0026style=flat)](https://github.com/pingcap/tiunimanager-ui/releases)\n[![License](https://img.shields.io/badge/license-Apache--2.0-green?style=flat)](./LICENSE)\n\nTiUniManager UI is a general purpose, web-based UI for [TiUniManager](https://github.com/pingcap/tiunimanager), a database operation and maintenance management platform for TiDB.\n\nIt allows users to view and manage TiDB clusters through the web-based UI.\n\nSome of the features the TiUniManager UI supports:\n\n- Cluster creation, deletion, scaling-out, cloning, upgrading etc...\n- Realtime monitoring and alerting of cluster status\n- Scheduled automatic and manual backups for cluster data\n- Cluster data import and export\n- Replicating change data to various downstreams\n- Cluster parameters management\n\n## Getting Started\n\nFirst, you need to ensure that there is a local or remote TiUniManager server deployed via tiup-em available to provide services.\n\n### Prerequisites\n\nThe followings are required for developing TiUniManager UI:\n\n- [Git](https://git-scm.com/downloads)\n- [Go 1.17+](https://go.dev/doc/install)\n- [Node.js 16+](https://nodejs.org/)\n- [Yarn 1.22+](https://classic.yarnpkg.com/en/docs/install)\n\n### Getting the sources\n\n```bash\n# Clone our GitHub repository:\ngit clone https://github.com/pingcap/tiunimanager-ui\n\n# Go to the tiunimanager-ui directory:\ncd tiunimanager-ui\n```\n\n### Installing dependencies\n\n```bash\n# Install project dependencies (package.json)\nyarn install\n\n# Bootstrap tools\nyarn bootstrap\n```\n\n### Generate external codes\n\nNext, generate remote request modules and error message translation files.\n\n```bash\nyarn generate\n```\n\n### Configure environment variables\n\nIf your TiUniManager server is running locally and is deployed using the default configuration, you can skip this section.\n\nOtherwise, you need to finish the following steps.\n\n1. Create a `.env.local` file in the root directory of the project.\n2. Paste the following contents into the `.env.local` file.\n\n```ini\n# Replace {xxxx-host} with the real host of the services\n# for your TiUniManager server.\n# See the TiUniManager topology config.yaml for more details.\n# config.yaml is located in the /home/tidb directory of the machine\n# running your TiUniManager server.\n\n# System external services\nVITE_MONITOR_URL=\"http://{grafana-host}/d/em000001/em-server?orgId=1\u0026refresh=10s\u0026kiosk=tv\"\nVITE_LOG_URL=\"http://{kibana-host}/app/discover\"\nVITE_ALERT_URL=\"http://{alertmanager-host}\"\nVITE_TRACER_URL=\"http://{tracer-host}\"\n\n# Dev server proxy\nVITE_PROXY_WEB_TARGET=\"http://{web-srv-host}\"\nVITE_PROXY_API_TARGET=\"http://{api-srv-host}\"\nVITE_PROXY_FS_TARGET=\"http://{file-srv-host}\"\n```\n\n### Build and run\n\nNow, run the following command to start a development server.\n\n```bash\nyarn dev\n```\n\nThat's it! You can access TiUniManager UI through http://127.0.0.1:3000.\n\n## Browser support\n\nTiUniManager UI has been tested on modern evergreen browsers.\n\nIt generally supports:\n\n- Google Chrome 79+ (Windows, macOS, Linux)\n- Mozilla Firefox 72+ (Windows, macOS, Linux)\n- Apple Safari 14+ (macOS)\n- Microsoft Edge 79+ (Windows)\n\n## Need help?\n\nPlease use [Github Discussions](https://github.com/pingcap/tiunimanager-ui/discussions) for help requests and how-to questions.\n\nPlease open GitHub issues for bugs only, not general help requests. You can search previous issues before creating a new issue.\n\n## Interested in contributing?\n\nRead through our [contributing guidelines](./CONTRIBUTING.md) to learn about our submission process and more.\n\nIf you want to contribute through code, read the [development guide](./doc/development.md) to learn about our development process, and how to build your changes to TiUniManager UI.\n\n## License\n\nCopyright 2022 PingCAP. All rights reserved.\n\nLicensed under the [Apache 2.0 License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpingcap%2Ftiunimanager-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpingcap%2Ftiunimanager-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpingcap%2Ftiunimanager-ui/lists"}