{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/380", "result": {"data":{"issuesJson":{"id":"ab2fe5ac-6b7e-55dd-9e31-9c4acdd881d3","title":"mongo-express/mongo-express: 基于 Web 的 MongoDB 管理界面，使用 Node.js 和 Express 编写","number":380,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposmongo-express/mongo-express
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

mongo-express

\n

\"npm \"npm\" \"GitHub \"Known
\n\"Build

\n

A web-based MongoDB admin interface written with Node.js, Express, and Bootstrap 5

\n

Features

\n\n

Screenshots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Home PageDatabase ViewCollection ViewEditing A Document
\n

These screenshots are from version 0.30.40
\nView the album for more screenshots: (server status, database views, etc..)
\nhttps://imgur.com/a/9vHsF

\n

Development

\n

To test or develop with the latest version (master branch) you can install using this git repository:

\n
npm i mongo-express@github:mongo-express/mongo-express\nOR\nyarn add mongo-express@github:mongo-express/mongo-express\nOR\npnpm add mongo-express@github:mongo-express/mongo-express\n
\n

Copy config.default.js to config.js and edit the default property to fit your local environment

\n

Run the development build using:

\n
npm run start-dev\nOR\nyarn start-dev\nOR\npnpm run start-dev\n
\n

Usage (npm / yarn / pnpm / CLI)

\n

mongo-express requires Node.js v18.18 or higher.

\n

To install:

\n
npm i -g mongo-express\nOR\nyarn add -g mongo-express\nOR\npnpm add -g mongo-express\n
\n

Or if you want to install a non-global copy:

\n
npm i mongo-express\nOR\nyarn add mongo-express\nOR\npnpm add mongo-express\n
\n

By default config.default.js is used where the basic access authentication is admin:pass. This is obviously not safe, and there are warnings in the console.

\n

To configure:

\n

Copy YOUR_PATH/node_modules/mongo-express/config.default.js into a new file called YOUR_PATH/node_modules/mongo-express/config.js.

\n

Note: YOUR_PATH will depend on your current OS user and system configuration. You can see it in the output text shown after executing npm install.

\n

Fill in your MongoDB connection details and any other options you want to change in config.js.

\n

You will also need to create a .env file with the variables for your cookie and session secrets, these are just default values

\n
ME_CONFIG_SITE_COOKIESECRET: 'cookiesecret',\nME_CONFIG_SITE_SESSIONSECRET: 'sessionsecret',\n
\n

To run:

\n
cd YOUR_PATH/node_modules/mongo-express/ && node app.js\n
\n

or if you installed it globally, you can immediately start mongo-express like this:

\n
mongo-express\n
\n

You can add some configuration options. Example:

\n
node app.js --url mongodb://127.0.0.1:27017\n
\n

or:

\n
mongo-express --URL mongodb://127.0.0.1:27017\n
\n

Configuration options:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
OptionShortDescription
--version-Voutput the version number
--url <url>-U <url>connection string url (<url> example: mongodb://127.0.0.1:27017)
--admin-aenable authentication as admin
--port <port>-p <port>listen on specified port (default <port> is 8081)
--help-hdisplay help for command options
\n

Usage (Express 4 middleware)

\n

To mount as Express 4 middleware (see node_modules/mongo-express/app.js):

\n
var mongo_express = require('mongo-express/lib/middleware')\nvar mongo_express_config = require('./mongo_express_config')\n\napp.use('/mongo_express', mongo_express(mongo_express_config))\n
\n

Usage (Docker)

\n

Make sure you have a running MongoDB container on a Docker network (--network some-network below) with --name or --network-alias set to mongo. Alternatively, set the connection string ME_CONFIG_MONGODB_URL to the proper connection for your MongoDB container on your Docker network.

\n

Use the Docker Hub image:

\n
$ docker run -it --rm -p 8081:8081 --network some-network mongo-express
\n

Build from source:

\n

Build an image from the project directory, then run the image.

\n
$ docker build -t mongo-express .\n$ docker run -it --rm -p 8081:8081 --network some-network mongo-express
\n

You can use the following environment variables to modify the container's configuration:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDefaultDescription
ME_CONFIG_MONGODB_URLmongodb://admin:pass@localhost:27017/db?ssl=false
ME_CONFIG_MONGODB_ENABLE_ADMINfalseEnable administrator access. Send strings: \"true\" or \"false\".
ME_CONFIG_MONGODB_AUTH_USERNAMEadminDatabase username (only needed if ENABLE_ADMIN is \"false\").
ME_CONFIG_MONGODB_AUTH_PASSWORDpassDatabase password (only needed if ENABLE_ADMIN is \"false\").
ME_CONFIG_MONGODB_ALLOW_DISK_USEfalseRemove the limit of 100 MB of RAM on each aggregation pipeline stage.
ME_CONFIG_MONGODB_TLSfalseUse TLS client certificate
ME_CONFIG_MONGODB_TLS_ALLOW_CERTStrueValidate mongod server certificate against CA
ME_CONFIG_MONGODB_TLS_CA_FILE``CA certificate File
ME_CONFIG_MONGODB_TLS_CERT_FILE``TLS client certificate file
ME_CONFIG_MONGODB_TLS_CERT_KEY_FILE``TLS client certificate key file
ME_CONFIG_MONGODB_TLS_CERT_KEY_FILE_PASSWORD``TLS client certificate key file password
ME_CONFIG_MONGODB_URL_FILE``File version of ME_CONFIG_MONGODB_URL
ME_CONFIG_MONGODB_AWS_DOCUMENTDBfalseThis allow AWS DocumentDB compatibility (experimental)
ME_CONFIG_SITE_BASEURL/Set the express baseUrl to ease mounting at a subdirectory. Remember to include leading and trailing slash.
ME_CONFIG_HEALTH_CHECK_PATH/statusSet the mongo express healthcheck path. Remember to add the forward slash at the start.
ME_CONFIG_SITE_COOKIESECRETcookiesecretString used by cookie-parser middleware to sign cookies.
ME_CONFIG_SITE_SESSIONSECRETsessionsecretString used to sign the session ID cookie by express-session middleware.
ME_CONFIG_BASICAUTHfalseDeprecated, use ME_CONFIG_BASICAUTH_ENABLED instead.
ME_CONFIG_BASICAUTH_ENABLEDfalseEnable Basic Authentication. Send strings: \"true\" or \"false\".
ME_CONFIG_BASICAUTH_USERNAME``mongo-express web login name. If not defined, admin is the username.
ME_CONFIG_BASICAUTH_USERNAME_FILE``File version of ME_CONFIG_BASICAUTH_USERNAME
ME_CONFIG_BASICAUTH_PASSWORD``mongo-express web login password. If not defined, pass is the password.
ME_CONFIG_BASICAUTH_PASSWORD_FILE``File version of ME_CONFIG_BASICAUTH_PASSWORD
ME_CONFIG_OIDCAUTH_ENABLEDfalseEnable OpenIdConnect Authentication. Send strings: \"true\" or \"false\".
ME_CONFIG_OIDCAUTH_ISSUER``OAuth2 Issuer. Root URL to the openidconnect metadata eg. \"<issuer>/.well-known/openid-configuration\"
ME_CONFIG_OIDCAUTH_ISSUER_FILE``File version of ME_CONFIG_OIDCAUTH_ISSUER
ME_CONFIG_OIDCAUTH_CLIENTID``OAuth2 ClientId. The client must be private and allowed to perform the Authorization Code Flow grant.
ME_CONFIG_OIDCAUTH_CLIENTID_FILE``File version of ME_CONFIG_OIDCAUTH_CLIENTID
ME_CONFIG_OIDCAUTH_CLIENTSECRET``OAuth2 Client Secret.
ME_CONFIG_OIDCAUTH_CLIENTSECRET_FILE``File version of ME_CONFIG_OIDCAUTH_CLIENTSECRET
ME_CONFIG_OIDCAUTH_SECRET``A random secret used by the library to init the Authorization Code Flow (required)
ME_CONFIG_OIDCAUTH_SECRET_FILE``File version of ME_CONFIG_OIDCAUTH_SECRET_FILE
ME_CONFIG_OIDCAUTH_BASEURL``OAuth2 base url. It's used to build the redirect URL eg. \"<base-url>/callback\". If not specified ME_CONFIG_SITE_BASEURL will be used.
ME_CONFIG_OIDCAUTH_BASEURL_FILE``File version of ME_CONFIG_OIDCAUTH_BASEURL
ME_CONFIG_REQUEST_SIZE100kbUsed to configure maximum Mongo update payload size. CRUD operations above this size will fail due to restrictions in body-parser.
ME_CONFIG_OPTIONS_READONLYfalseif readOnly is true, components of writing are not visible.
ME_CONFIG_OPTIONS_FULLWIDTH_LAYOUTfalseIf set to true an alternative page layout is used utilizing full window width.
ME_CONFIG_OPTIONS_PERSIST_EDIT_MODEfalseIf set to true, remain on the same page after clicking on the Save button
ME_CONFIG_OPTIONS_NO_DELETEfalseIf noDelete is true, components of deleting are not visible.
ME_CONFIG_OPTIONS_NO_EXPORTfalseIf noExport is true, components of exporting are not visible.
ME_CONFIG_OPTIONS_CONFIRM_DELETEfalseIf confirmDelete is set to 'true', a modal for confirming deletion is displayed
ME_CONFIG_OPTIONS_COLLAPSIBLE_JSONtrueIf set to true, jsons will be displayed collapsible
ME_CONFIG_SITE_SSL_ENABLEDfalseEnable SSL.
ME_CONFIG_SITE_SSL_CRT_PATH SSL certificate file.
ME_CONFIG_SITE_SSL_KEY_PATH SSL key file.
ME_CONFIG_SITE_GRIDFS_ENABLEDfalseEnable gridFS to manage uploaded files.
ME_CONFIG_DOCUMENTS_PER_PAGE10How many documents you want to see at once in collection view
PORT8081port that mongo-express will run on.
VCAP_APP_HOSTlocalhostaddress that mongo-express will listen on for incoming connections.
\n

Example:

\n
docker run -it --rm \\\n    --name mongo-express \\\n    --network web_default \\\n    -p 8081:8081 \\\n    -e ME_CONFIG_BASICAUTH_ENABLED=\"false\" \\\n    -e ME_CONFIG_MONGODB_URL=\"mongodb://mongo:27017\" \\\n    mongo-express\n
\n

This example links to a container name typical of docker-compose, changes the editor's color theme, and disables basic authentication.

\n

To use:

\n

The default port exposed from the container is 8081, so visit http://localhost:8081 or whatever URL/port you entered into your config (if running standalone) or whatever config.site.baseUrl (if mounting as a middleware).

\n

Using Docker Extensions:

\n

Pre-requisite:

\n\n

Usage:

\n

By using Mongo Express Docker Extension, it's easy to setup Mongo Express on Docker Desktop with just one click.

\n

Usage (IBM Cloud)

\n

Deploy to IBM Cloud

\n

Doing manually:

\n\n

Doing automatically:

\n\n

\"Deploy

\n

Then, take the following action to customize to your environment:

\n\n

Usage (OpenIdConnect Authentication)

\n

Usage with the mongo-express package

\n

If you install mongo-express as a package, install the express-openid-connect dependency:

\n
yarn add express-openid-connect
\n

Setup the OAuth2 application

\n

The current implementation supports OAuth2 Authorization Code Flow Grant, to make it work you need to setup a client on your Identity Provider, and pass the parameters to the application:

\n
ME_CONFIG_OIDCAUTH_ENABLED=true\nME_CONFIG_OIDCAUTH_BASEURL=https://<domain>/<base-url>\nME_CONFIG_OIDCAUTH_ISSUER=<authority>\nME_CONFIG_OIDCAUTH_CLIENTID=<client-id>\nME_CONFIG_OIDCAUTH_CLIENTSECRET=<client-secret> # Optional\nME_CONFIG_OIDCAUTH_SECRET=<random-generated-string>\nME_CONFIG_SITE_COOKIESECRET=<client-secret>\nME_CONFIG_SITE_BASEURL=/<base-url>
\n

To register your client, you will need the application's redirect URI, which can be obtained by appending /callback to the application base URL: Eg. https://example.com/mongo-express/callback

\n

Search

\n\n

See MongoDB db.collection.find() documentation for examples and exact usage.

\n

Planned features

\n

Pull Requests are always welcome! 💖

\n

Limitations

\n\n

E2E Testing

\n
We are currently trying to use Cypress, to open cypress use the command `cypress open`\nTo instrument the code to allow the E2E coverage to run, please run this command: `yarn nyc instrument --compact=false lib instrumented`\n
\n

Not Tested

\n\n

JSON documents are parsed through a javascript virtual machine, so the web
\ninterface can be used for executing malicious javascript on a server.

\n

mongo-express should only be used privately for development purposes.

\n

BSON Data Types

\n

The following BSON data types are supported in the mongo-express document editor/viewer.

\n

Native Javascript Types

\n

Strings, numbers, lists, booleans, null, etc.

\n

All numbers in Javascript are 64-bit floating points.

\n

ObjectID/ObjectId

\n
ObjectId()\n
\n

Creates a new Object ID type.

\n
ObjectId(id)\n
\n

Use Object ID with the given 24-digit hexadecimal string.

\n

ISODate

\n
ISODate()\n
\n

Creates a new ISODate object with the current time.

\n

new Date() can also be used (note the new keyword there).

\n
ISODate(timestamp)\n
\n

Uses ISODate object with the given timestamp.

\n

UUID

\n
UUID()\n
\n

Creates a new UUID v4.

\n

Can also be used new UUID() (note the new keyword there).

\n
UUID(uuid)\n
\n

Uses UUID v4 with the given 24-digit hexadecimal string.

\n

Example: UUID(\"dee11d4e-63c6-4d90-983c-5c9f1e79e96c\") or UUID(\"dee11d4e63c64d90983c5c9f1e79e96c\")

\n

DBRef/Dbref

\n
DBRef(collection, objectID)\n\nDBRef(collection, objectID, database)\n
\n

Object ID is the ID string, not the ObjectId type.

\n

The database value is optional.

\n

Timestamp

\n
Timestamp()\n
\n

Creates a new Timestamp object with a value of 0.

\n
Timestamp(time, ordinal)\n
\n

Example: Timestamp(ISODate(), 0).

\n

See http://www.mongodb.org/display/DOCS/Timestamp+data+type for more info about the Timestamp data type.

\n

Code

\n
Code(code)\n
\n

Code can be a native Javascript function, or it can be a string.

\n

Specifying a scope/context is not supported.

\n

MinKey

\n
MinKey()\n
\n

MaxKey

\n
MaxKey()\n
\n

Symbol

\n
Symbol(string)\n
\n

Example Document

\n

Here is an example of a document which can be read/edited in mongo-express (media truncated for legibility):

\n
{\n  \"_id\": ObjectId(),\n  \"dates\": {\n    \"date\": ISODate(\"2012-05-14T16:20:09.314Z\"),\n    \"new_date\": ISODate(),\n    \"alternative\": new Date()\n  },\n  \"photo\": \"data:image/jpeg;base64,/9j/4...\",\n  \"video\": \"data:video/webm;base64,GkXfo...\",\n  \"audio\": \"data:audio/ogg;base64,T2dnUw...\",\n  \"bool\": true,\n  \"string\": \"hello world!\",\n  \"list of numbers\": [\n    123,\n    111e+87,\n    4.4,\n    -12345.765\n  ],\n  \"reference\": DBRef(\"collection\", \"4fb1299686a989240b000001\"),\n  \"ts\": Timestamp(ISODate(), 1),\n  \"minkey\": MinKey(),\n  \"maxkey\": MaxKey(),\n  \"func\": Code(function() { alert('Hello World!') }),\n  \"symbol\": Symbol(\"test\")\n}\n
","updatedAt":"2025-05-21T16:12:10Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"GUI-MongoDB","color":"810350"}},{"node":{"name":"mongo-express","color":"8fd278"}}]},"comments":{"edges":[]}}},"pageContext":{"number":380,"previous":{"title":"gcollazo/mongodbapp: 一个将 MongoDB 服务端封装为一个 MacOS APP 的开源项目，安装之后，运行会启动一个 MongoDB 服务。","number":379},"next":{"title":"kubeshop/monokle: 通过可视化 UI 更好地创建、理解和部署 YAML 清单，该 UI 还提供策略验证和集群见解","number":381}}}, "staticQueryHashes": ["151096407","2861350382"]}