{"id":24314622,"url":"https://github.com/haohanyang/compass-web","last_synced_at":"2025-09-26T21:30:36.111Z","repository":{"id":271592515,"uuid":"910116011","full_name":"haohanyang/compass-web","owner":"haohanyang","description":"MongoDB Compass on the browser","archived":false,"fork":false,"pushed_at":"2025-09-19T21:08:34.000Z","size":4736,"stargazers_count":45,"open_issues_count":4,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-19T23:26:23.988Z","etag":null,"topics":["database","gui","mongodb","mongodb-compass"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/compass-web","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haohanyang.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-30T14:31:52.000Z","updated_at":"2025-09-19T21:08:39.000Z","dependencies_parsed_at":"2025-06-11T16:49:23.758Z","dependency_job_id":"034c67c1-2110-43ec-8fef-bc86642b7798","html_url":"https://github.com/haohanyang/compass-web","commit_stats":null,"previous_names":["haohanyang/compass-web"],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/haohanyang/compass-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haohanyang%2Fcompass-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haohanyang%2Fcompass-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haohanyang%2Fcompass-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haohanyang%2Fcompass-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haohanyang","download_url":"https://codeload.github.com/haohanyang/compass-web/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haohanyang%2Fcompass-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276962130,"owners_count":25736175,"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","status":"online","status_checked_at":"2025-09-25T02:00:09.612Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["database","gui","mongodb","mongodb-compass"],"created_at":"2025-01-17T10:14:35.737Z","updated_at":"2025-09-26T21:30:36.106Z","avatar_url":"https://github.com/haohanyang.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MongoDB Compass Web\n\n![npm](https://img.shields.io/npm/v/compass-web.svg)\n![downloads](https://img.shields.io/npm/dw/compass-web)\n\nA 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.\n\n## ![screenshot light theme](/images/screenshot4.png)\n\n## ![screenshot dark theme](/images/screenshot5.png)\n\n## Unsupported Features\n\nNot all Compass Desktop features are available on Compass Web. Here is non-exhaustive list unsupported features.\n\n- ~~Export to JSON/CSV~~ (Supported since 0.2.2)\n- ~~Import from JSON/CSV~~ (Supported since 0.2.3)\n- Mongo Shell\n- Proxy\n- Gen AI\n\n## 📦 Installation\n\nInstall `compass-web` npm package or pull Docker image `haohanyang/compass-web`\n\n```bash\nnpm install compass-web -g\n```\n\n```bash\ndocker pull haohanyang/compass-web\n```\n\n## 🧭 Usage\n\nStart the server with MongoDB connection string(s). The parameters are configured via program arguments or environment variables.\n\n```bash\ncompass-web --mongo-uri \"mongodb://localhost:27017\"\n\n# or configure via CW_MONGO_URI environment variable\nCW_MONGO_URI=\"mongodb://localhost:27017\" compass-web\n\n# or use npx\nnpx compass-web --mongo-uri \"mongodb://localhost:27017\"\n\n# multiple connection strings\ncompass-web --mongo-uri \"mongodb://localhost:27017 mongodb+srv://myusername:secrets@default-cluster.mongodb.net/?retryWrites=true\u0026w=majority\u0026appName=default-cluster\"\n```\n\nUse Docker:\n\n```\ndocker run -it -p 8080:8080 -e CW_MONGO_URI=\"mongodb://localhost:27017\" haohanyang/compass-web\n```\n\nCheck an example [docker-compose.yaml](./docker-compose.yaml) file if you want to use Docker Compose.\n\n## ⚙️ CLI Parameters\n\nYou can configure `compass-web` using command-line arguments or environment variables (prefixed with `CW_`).\n\n| Parameter               | Type   | Env Variable             | Description                                                                         | Default              |\n| ----------------------- | ------ | ------------------------ | ----------------------------------------------------------------------------------- | -------------------- |\n| `--mongo-uri`           | string | `CW_MONGO_URI`           | **Required.** MongoDB connection string(s). Separate multiple URIs with whitespace. | _Required_           |\n| `--port`                | number | `CW_PORT`                | Port to run the server on.                                                          | `8080`               |\n| `--host`                | string | `CW_HOST`                | Host to run the server on.                                                          | `localhost`          |\n| `--app-name`            | string | `CW_APP_NAME`            | Name of the application on.                                                         | `Compass Web`        |\n| `--org-id`              | string | `CW_ORG_ID`              | Organization ID associated with the connection.                                     | `default-org-id`     |\n| `--project-id`          | string | `CW_PROJECT_ID`          | Project ID associated with the connection.                                          | `default-project-id` |\n| `--cluster-id`          | string | `CW_CLUSTER_ID`          | Cluster ID associated with the connection.                                          | `default-cluster-id` |\n| `--basic-auth-username` | string | `CW_BASIC_AUTH_USERNAME` | Username for Basic HTTP authentication scheme.                                      | `null`               |\n| `--basic-auth-password` | string | `CW_BASIC_AUTH_PASSWORD` | Password for Basic HTTP authentication scheme.                                      | `null`               |\n\n## Settings\n\nHere are editable user preferences you can configure on **Settings** in the UI:\n\n- Theme(dark/light)\n- Default Sort for Query Bar\n\n## Build\n\nClone the repo and fetch the upstream dependency [compass](https://github.com/mongodb-js/compass)\n\n```bash\ngit clone https://github.com/haohanyang/compass-web.git\ncd compass-web \u0026\u0026 git submodule update --init --recursive --single-branch --depth 1\n```\n\nBuild the dependencies\n\n```bash\nbash bootstrap.sh\npnpm i --frozen-lockfile\n```\n\nBuild the front end.\n\n```bash\npnpm run build\n```\n\nStart the app\n\n```bash\nnode app.js --mongo-uri \"mongodb://localhost:27017\"\n```\n\n## Credits\n\n[MongoDB Compass](https://github.com/mongodb-js/compass)\n\n## License\n\n[Server Side Public License](/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaohanyang%2Fcompass-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaohanyang%2Fcompass-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaohanyang%2Fcompass-web/lists"}