Meilisearch-UI

ENGLISH ｜ 中文

An open-source, pretty, simple and fast meilisearch admin dashboard UI for managing your meilisearch instances

[IMPORTANT] The main branch may be unstable or unavailable during development.

Please use release instead of main branch to obtain a stable version app

Features

🚀 Indexes CRUD

🔎 Search documents

💪 Documents management

🛠️️ Index settings

⚓ Multiple instances management

🔒 Data is stored inside your browser

📦 Docker image support

🎱 Singleton mode support (easy to integrate with your own apps)

🌐 I18n support (en, zh)

Quick start

⚠️ This app have not achieved responsive design totally, so mind that only use this app on desktop to gain better experience.

CORS settings

✅ Remember update CORS settings in your instance server for this ui domain before using.

Because this app use meilisearch official JS client to call your meilisearch instance, you need to manually configure CORS settings in your web server to make sure ui panel can access your instance server with api calls.

Add your ui panel deployment domain to your instance server cors list.

ex:

# ... other configurations
     add_header Access-Control-Allow-Origin "your.meilisearch-ui.domain.com";
# ... other configurations

Learn how to configure CORS settings in your web server

Online use

There is a live demo 👉 meilisearch-ui, deploy on Vercel.

Docker

docker pull riccoxie/meilisearch-ui:latest

docker run -d --restart=always --name="meilisearch-ui" -p <your-port>:24900 riccoxie/meilisearch-ui:latest

Deploy on Vercel

You can deploy this app to the cloud with Vercel

Just one click the button below to deploy this app automatically

Configures

Base Path

See this issue.

You can configure the base path of this app by setting the BASE_PATH environment variable.

For example, if you want to deploy this app to the /meilisearch-ui path, you can set the BASE_PATH environment variable to /meilisearch-ui.

docker run -d --restart=always --name="meilisearch-ui" -p <your-port>:24900 -e BASE_PATH="/meilisearch-ui" riccoxie/meilisearch-ui:latest

Singleton mode

See this issue.

If you want to use this app with only one meilisearch instance, you can enable the singleton mode by below config.

Then you will directly jump to the instance page when you open this app.

Just need to start this app with some env variables like below.

VITE_SINGLETON_MODE=true
VITE_SINGLETON_HOST=http://localhost:27700
VITE_SINGLETON_API_KEY=your-api-key

• VITE_SINGLETON_MODE tell this app to enable singleton mode.
• VITE_SINGLETON_HOST is the meilisearch host url.
• VITE_SINGLETON_API_KEY is the meilisearch master key.

Development

Install pnpm first.

git clone git@github.com:riccox/meilisearch-ui.git

cd meilisearch-ui

pnpm install

pnpm dev

Built with ♥

• Meilisearch
• Tanstack
• React v18
• Arco design
• Semi UI
• Mantine UI
• Next UI
• Radix UI
• Tabler Icon
• Lucide Icon
• Monaco Editor for react
• TypeScript
• Vite
• Zustand
• TailwindCSS
• React Error Boundary
• Prettier
• Fuse.js
• Echarts
• Lodash.js
• Immer
• Ahooks
• Framer motion
• react-json-view
• Dayjs
• I18Next
• UnoCSS
• qs
• Sonner
• Vaul
• Zod