Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milvus-io/milvus-insight
Milvus management GUI
https://github.com/milvus-io/milvus-insight
milvus milvus-gui milvus-insight vector-database
Last synced: about 2 months ago
JSON representation
Milvus management GUI
- Host: GitHub
- URL: https://github.com/milvus-io/milvus-insight
- Owner: milvus-io
- License: apache-2.0
- Archived: true
- Created: 2021-06-16T08:57:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-24T04:23:11.000Z (almost 3 years ago)
- Last Synced: 2024-04-17T04:09:16.391Z (5 months ago)
- Topics: milvus, milvus-gui, milvus-insight, vector-database
- Language: TypeScript
- Homepage:
- Size: 3.44 MB
- Stars: 87
- Watchers: 8
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Notice: Unmaintained
This repo is no longer maintained.
However we have the [Attu](https://github.com/zilliztech/attu) to help manage Milvus.
# Milvus insight
[](https://badges.aleen42.com/src/typescript.svg)
[](https://img.shields.io/docker/pulls/milvusdb/milvus-insight)
[](https://codecov.io/gh/zilliztech/milvus-insight)
Milvus insight provides an intuitive and efficient GUI for Milvus, allowing you to interact with your databases and manage your data with just few clicks.
## Features and Roadmap
Milvus insight is under rapid development and we are adding new features weekly, here are the current plan, we will release a version once a feature is available.
- Manage collections/partitions
- Manage index
- Basic statistics overview
- Load/release collections for search
- Insert entities
- Vector search with advanced filter
- Milvus system view(TBD)
- Data view (TBD)
- View milvus node configuration(TBD)
- Vector Visualization(TBD)
- More...
## Quick start
### Before you start
Ensure you have Milvus installed on [your server](https://milvus.io/docs/install_standalone-docker.md) or [cluster](https://milvus.io/docs/install_cluster-docker.md), and Milvus insight only supports Milvus 2.x.
### ⭐️ Start a Milvus insight instance
```code
docker run -p 8000:3000 -e HOST_URL=http://{ milvus insight ip }:8000 -e MILVUS_URL={milvus server ip}:19530 milvusdb/milvus-insight:latest
```
Once you start the docker, open the browser, type `http://{ milvus insight ip }:8000`, you can view the Milvus insight.
#### Params
| Parameter | Example | required | description |
| :--------- | :---------------------- | :------: | ------------------------------------------- |
| HOST_URL | http://192.168.0.1:8000 | true | Where Milvus insight container is installed |
| MILVUS_URL | 192.168.0.1:19530 | false | Optional, Milvus server URL |
Tip: **127.0.0.1 or localhost will not work when runs on docker**
#### Try the dev build
**_note_** We plan to release Milvus insight once a feature is done. Also, if you want to try the nightly build, please pull the docker image with the `dev` tag.
```code
docker run -p 8000:3000 -e HOST_URL=http://{ your machine IP }:8000 -e MILVUS_URL={ your machine IP }:19530 milvusdb/milvus-insight:dev
```
## ✨ Building and Running Milvus insight, and/or Contributing Code
You might want to build Milvus-insight locally to contribute some code, test out the latest features, or try
out an open PR:
### Build server
1. Fork and clone the repo
2. `cd server` go to the server directory
3. `yarn install` to install dependencies
4. Create a branch for your PR
### Build client
1. Fork and clone the repo
2. `cd client` go to the client directory
3. `yarn install` to install dependencies
4. Create a branch for your PR
### Milvus
New to milvus? Milvus is an open-source vector database built to power AI applications and embedding similarity search.
### Userful links
- [Milvus installation guide](https://milvus.io/docs/v2.0.0/install_standalone-docker.md)
- [Milvus python sdk](https://milvus.io/docs/v2.0.0/explore_pymilvus.md)
- [Milvus bootcamp](https://milvus.io/bootcamp)
## Community
👉 Join the Milvus community on [Slack](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ) to share your suggestions, advice, and questions with our engineering team.
#### ❓ Questions? Problems?
- If you've found a bug or want to request a feature, please create a [GitHub Issue](https://github.com/milvus-io/milvus-insight/issues/new/choose).
Please check to make sure someone else hasn't already created an issue for the same topic.
- Need help using Milvus insight? Ask away on our [Milvus insight Discuss Forum](https://github.com/milvus-io/milvus-insight/discussions) and a fellow community member or
Milvus engineer will be glad to help you out.
[milvus-doc]: https://milvus.io/docs/home
[nestjs]: https://docs.nestjs.com/