{"id":24358555,"url":"https://github.com/surister/cratedb-admin-alt","last_synced_at":"2025-03-12T08:17:37.637Z","repository":{"id":197861773,"uuid":"699028230","full_name":"surister/cratedb-admin-alt","owner":"surister","description":"Alternative admin panel for CrateDB databases","archived":false,"fork":false,"pushed_at":"2025-01-28T19:07:01.000Z","size":5142,"stargazers_count":12,"open_issues_count":10,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-28T20:23:16.296Z","etag":null,"topics":["admin-dashboard","admin-panel","cratedb","database","database-management"],"latest_commit_sha":null,"homepage":"","language":"Vue","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/surister.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-10-01T17:54:24.000Z","updated_at":"2025-01-28T19:07:05.000Z","dependencies_parsed_at":"2023-10-03T03:46:58.791Z","dependency_job_id":"d699bff8-d849-4146-8410-578395a020b7","html_url":"https://github.com/surister/cratedb-admin-alt","commit_stats":null,"previous_names":["surister/crate-admin-alt"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surister%2Fcratedb-admin-alt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surister%2Fcratedb-admin-alt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surister%2Fcratedb-admin-alt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surister%2Fcratedb-admin-alt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/surister","download_url":"https://codeload.github.com/surister/cratedb-admin-alt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243179892,"owners_count":20249187,"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":["admin-dashboard","admin-panel","cratedb","database","database-management"],"created_at":"2025-01-18T20:19:20.263Z","updated_at":"2025-03-12T08:17:37.631Z","avatar_url":"https://github.com/surister.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Docker Image Version](https://img.shields.io/docker/v/surister/cratedbaltadmin)\n![Docker Image Size](https://img.shields.io/docker/image-size/surister/cratedbaltadmin)\n\n# CrateDB Alt panel - 0.3.2\n\nThis is an Admin panel that intends to support all the features from CrateDB 5.4+ and add extra\nfunctionality to make the lives of CrateDB users easy.\n\n## Why this tool?\n\nOn-prem CrateDB currently ships with the [admin-ui](https://github.com/crate/crate-admin), it is no\nlonger developed, it is quite dated and lacks certain modern features, it still works fine for\nquerying though.\n\nCloud users have their own ui in https://console.cratedb.cloud/.\n\nThis admin tool is intended for on-prem users that want to have a modern,\nupdated and feature rich solution.\n\n## Features:\n\n- Statistics: View your Node load, queries per second and query duration in live charts.\n- Health: View your node health and node checks live.\n- Console: Modern console with CrateDB syntax highlighting, code completion, different console tabs,\n  cancel current running query, query history, auto format, live update.\n- Tables: View the system and your user tables and views information, size, records, view schema,\n  show create, drop table, data sampling, table querying and table creation from the UI.\n- Cluster: View your cluster live information such as version, os info, loads, heap usage, disk\n  usage and live view of the current running jobs.\n- Users: View current existing users, users permissions, add new permission, revoke permissions,\n  drop user, create user, alter user.\n- Logs: Actions from the Admin UI (Example: drop table, create user, drop user..) are logged and can\n  be filtered depending on the severity.\n- Repositories \u0026 Snapshots: Create, delete and admin your repositories, create, delete and restore\n  the snapshots.\n- Notebooks: Full-on notebooks with Markdown support, directly connected to your CrateDB instance\n  and automatic save-on disk (local storage)\n\n![](https://raw.githubusercontent.com/surister/crate-admin-alt/master/screenshots/overview.png)\n![](https://raw.githubusercontent.com/surister/crate-admin-alt/master/screenshots/console.png)\n![](https://raw.githubusercontent.com/surister/crate-admin-alt/master/screenshots/tables.png)\n![](https://raw.githubusercontent.com/surister/crate-admin-alt/master/screenshots/cluster_jobs.png)\n![](https://raw.githubusercontent.com/surister/crate-admin-alt/master/screenshots/notebooks.png)\n\nYou can see more screenshots in `/screenshots`\n\n## Getting started\n\nThe easiest way of getting started is to run a docker container:\n\n```shell\ndocker run -p 9000:80 surister/cratedbaltadmin:latest\n```\n\nWe also upload different versions, more\nin https://hub.docker.com/repository/docker/surister/cratedbaltadmin/general\n\n## Which version should I pick for my CrateDB instance?\n\nIf you are running a CrateDB version \u003e=5.4, any version of the admin UI should work, bear in mind\nthat some features might not be available as they are directly linked to the running CrateDB\nversion, you should upgrade your CrateDB cluster.\n\nIf you are running \u003c5.4, the admin ui might not fully work;\nI would only rely on basic console querying, since many features depend on CrateDB \u003e2-3 version;\nagain, you shouldn't be running such an old version, upgrade your CrateDB cluster!\n\n## Solving the CORS 'issue'\n\nWhen running CrateDB, please make sure to enable *Cross-Origin\nResource Sharing* in your [CrateDB configuration], like:\n```\n-Chttp.cors.enabled=true\n-Chttp.cors.allow-origin=http://localhost:9000\n```\n\nWhen invoking cratedb-admin-alt, you need to supply the `base_uri` parameter,\nlike this:\n```\nhttp://localhost:9000/?base_uri=http://localhost:4200\n```\n\nAn incantation example using Docker would be:\n```shell\ndocker run --rm -d \\\n      --name=crate01 \\\n      --net=crate \\\n      -p 4200:4200 \\\n      --env CRATE_HEAP_SIZE=1g \\\n      crate -Cnetwork.host=_site_ \\\n            -Cnode.name=crate01 \\\n            -Chttp.cors.enabled=true \\\n            -Chttp.cors.allow-origin=http://localhost:9000\n```\n\nBear in mind that if you run the admin panel from another port, it will have to match\nthe `http.cors.allow-origin` setting.\n\n## Developer setup\n\nClone the repo:\n\n`git clone git@github.com:surister/cratedb-admin-alt.git`\n\nInstall dependencies:\n\n```\n# yarn\nyarn\n\n# npm\nnpm install\n\n# pnpm\npnpm install\n\n# bun\nbun install\n```\n\n## CrateDB versions.\n\nThis panel supports v5.4.3 as the base version, any new version will be added afterward.\n\nFor maximum compatibility, any new version feature will be added with a versioned Component, meaning\nthat those features will only be unlocked if your connected CrateDB cluster supports it.\n\n## Known limitations\n\nWhile it is my intention to fully support everything, it's a daunting task, it is a very complex\nproduct, and it will take some time.\n\nThe following parameters are not supported in the Create table UI:\n\n- routing.allocation.include.{attribute}\n- routing.allocation.require.{attribute}\n- routing.allocation.exclude.{attribute}\n\nWe do not support restoring a snapshot from a partition.\n`PARTITION (partition_column = value [, ...])] [, ...]`\n\n## Contributing\n\nThis project is currently being developed by me, but it's open for contributions, also if you\nhave some ideas, feature request or happen to find a bug, please let me know in an issue, so it can\nbe addressed.\n\n\n[CrateDB configuration]: https://cratedb.com/docs/crate/reference/en/latest/config/node.html#cross-origin-resource-sharing-cors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurister%2Fcratedb-admin-alt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsurister%2Fcratedb-admin-alt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurister%2Fcratedb-admin-alt/lists"}