compass-web

library0.5.0jsnpmunverified

A browser-based port of MongoDB Compass (version 0.5.0) that provides a GUI for MongoDB databases. Released as an npm package and Docker image, it supports MongoDB Atlas, Amazon DocumentDB, and Azure Cosmos DB. Features include query export to JSON/CSV, data import, Gen AI integration, editable connections, and a Mongo shell (added in 0.5.0). Compass Web is built on top of @mongodb-js/compass-web v1.46.2 and is designed for easy deployment in web environments. It offers CLI and environment variable configuration, optional basic auth and OIDC support, and connection encryption. The project is actively maintained with frequent releases.

database

npm install compass-web

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · COMPASS-WEB

compass-web

databasejavascriptv0.5.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Installs and runs the Compass Web server with a local MongoDB connection.

# Install globally npm install -g compass-web # Run with a MongoDB URI compass-web --mongo-uri="mongodb://localhost:27017" # Or use Docker docker pull haohanyang/compass-web docker run -it --name compass-web -e CW_MONGO_URI="mongodb://localhost:27017" haohanyang/compass-web # Then open http://localhost:8080

Debug

Known issues

gotchaConnections without --master-password are stored in memory and lost on restart.

fix

Use --master-password to enable encrypted persistent storage.

affects: >=0.0.0

breaking--enable-edit-connections must be set to allow adding/editing connections in the UI.

fix

Pass --enable-edit-connections flag or set CW_ENABLE_EDIT_CONNECTIONS=true.

affects: >=0.4.0

deprecatedBasic auth is legacy and only works when OIDC is not configured.

fix

Use OIDC authentication instead of basic auth for production.

affects: >=0.0.0

gotchaMultiple --mongo-uri values must be space-separated, not comma-separated.

fix

Use space delimiters: --mongo-uri="uri1 uri2"

affects: >=0.0.0

gotchanode-gyp must be installed and functional on the host machine when using npm.

fix

Ensure build tools are installed (e.g., python, make, C++ compiler).

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'compass-web'

Global install not found or npm bin path not set.

fix

Install globally: npm install -g compass-web

Error: listen EADDRINUSE :::8080

Port 8080 is already in use.

fix

Use --port flag to specify a different port.

Error: Connection refused to MongoDB at localhost:27017

MongoDB server not running or unreachable.

fix

Start MongoDB or verify the connection string.

Upgrade

Version history

0.5.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

14 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/haohanyang/compass-web ↗

packagecompass-web ↗

homepagehttps://github.com/haohanyang/compass-web#readme ↗