https://github.com/haohanyang/compass-web
MongoDB Compass on the browser
https://github.com/haohanyang/compass-web
database gui mongodb mongodb-compass
Last synced: 4 months ago
JSON representation
MongoDB Compass on the browser
- Host: GitHub
- URL: https://github.com/haohanyang/compass-web
- Owner: haohanyang
- License: other
- Created: 2024-12-30T14:31:52.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-09-19T21:08:34.000Z (4 months ago)
- Last Synced: 2025-09-19T23:26:23.988Z (4 months ago)
- Topics: database, gui, mongodb, mongodb-compass
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/compass-web
- Size: 4.52 MB
- Stars: 45
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# MongoDB Compass Web
A port of the MongoDB Compass to Web. The frontend is rebuilt and re-packaged from the original [@mongodb-js/compass-web](https://www.npmjs.com/package/@mongodb-js/compass-web). It provides an easy way to view and interact with your databases from a browser, while keeping most of the MongoDB Compass features.
## 
## 
## Unsupported Features
Not all Compass Desktop features are available on Compass Web. Here is non-exhaustive list unsupported features.
- ~~Export to JSON/CSV~~ (Supported since 0.2.2)
- ~~Import from JSON/CSV~~ (Supported since 0.2.3)
- Mongo Shell
- Proxy
- Gen AI
## 📦 Installation
Install `compass-web` npm package or pull Docker image `haohanyang/compass-web`
```bash
npm install compass-web -g
```
```bash
docker pull haohanyang/compass-web
```
## 🧭 Usage
Start the server with MongoDB connection string(s). The parameters are configured via program arguments or environment variables.
```bash
compass-web --mongo-uri "mongodb://localhost:27017"
# or configure via CW_MONGO_URI environment variable
CW_MONGO_URI="mongodb://localhost:27017" compass-web
# or use npx
npx compass-web --mongo-uri "mongodb://localhost:27017"
# multiple connection strings
compass-web --mongo-uri "mongodb://localhost:27017 mongodb+srv://myusername:secrets@default-cluster.mongodb.net/?retryWrites=true&w=majority&appName=default-cluster"
```
Use Docker:
```
docker run -it -p 8080:8080 -e CW_MONGO_URI="mongodb://localhost:27017" haohanyang/compass-web
```
Check an example [docker-compose.yaml](./docker-compose.yaml) file if you want to use Docker Compose.
## ⚙️ CLI Parameters
You can configure `compass-web` using command-line arguments or environment variables (prefixed with `CW_`).
| Parameter | Type | Env Variable | Description | Default |
| ----------------------- | ------ | ------------------------ | ----------------------------------------------------------------------------------- | -------------------- |
| `--mongo-uri` | string | `CW_MONGO_URI` | **Required.** MongoDB connection string(s). Separate multiple URIs with whitespace. | _Required_ |
| `--port` | number | `CW_PORT` | Port to run the server on. | `8080` |
| `--host` | string | `CW_HOST` | Host to run the server on. | `localhost` |
| `--app-name` | string | `CW_APP_NAME` | Name of the application on. | `Compass Web` |
| `--org-id` | string | `CW_ORG_ID` | Organization ID associated with the connection. | `default-org-id` |
| `--project-id` | string | `CW_PROJECT_ID` | Project ID associated with the connection. | `default-project-id` |
| `--cluster-id` | string | `CW_CLUSTER_ID` | Cluster ID associated with the connection. | `default-cluster-id` |
| `--basic-auth-username` | string | `CW_BASIC_AUTH_USERNAME` | Username for Basic HTTP authentication scheme. | `null` |
| `--basic-auth-password` | string | `CW_BASIC_AUTH_PASSWORD` | Password for Basic HTTP authentication scheme. | `null` |
## Settings
Here are editable user preferences you can configure on **Settings** in the UI:
- Theme(dark/light)
- Default Sort for Query Bar
## Build
Clone the repo and fetch the upstream dependency [compass](https://github.com/mongodb-js/compass)
```bash
git clone https://github.com/haohanyang/compass-web.git
cd compass-web && git submodule update --init --recursive --single-branch --depth 1
```
Build the dependencies
```bash
bash bootstrap.sh
pnpm i --frozen-lockfile
```
Build the front end.
```bash
pnpm run build
```
Start the app
```bash
node app.js --mongo-uri "mongodb://localhost:27017"
```
## Credits
[MongoDB Compass](https://github.com/mongodb-js/compass)
## License
[Server Side Public License](/LICENSE)