mongo-express

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

Development

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

npm i mongo-express@github:mongo-express/mongo-express OR yarn add mongo-express@github:mongo-express/mongo-express OR pnpm add mongo-express@github:mongo-express/mongo-express

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

Run the development build using:

npm run start-dev OR yarn start-dev OR pnpm run start-dev

Usage (npm / yarn / pnpm / CLI)

_mongo-express_ requires Node.js v22 or higher.

To install:

npm i -g mongo-express OR yarn add -g mongo-express OR pnpm add -g mongo-express

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

npm i mongo-express OR yarn add mongo-express OR pnpm add mongo-express

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.

To configure:

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

_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.

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

You will also need to create a .env file with the variables for your cookie and session secrets. Replace these values with randomly generated secrets:

ME_CONFIG_SITE_COOKIESECRET: 'yourcookiesecret', ME_CONFIG_SITE_SESSIONSECRET: 'yoursessionsecret',

To run:

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

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

mongo-express

You can add some configuration options. Example:

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

or:

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

Configuration options: Option | Short | Description | - | - | - --version | -V | output the version number --url | -U | connection string url ( example: mongodb://127.0.0.1:27017) --admin | -a | enable authentication as admin --port | -p | listen on specified port (default is 8081) --help | -h | display help for command options

Usage (Express middleware)

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

var mongo_express = require('mongo-express/lib/middleware') var mongo_express_config = require('./mongo_express_config')

app.use('/mongo_express', mongo_express(mongo_express_config))

Usage (Docker)

Make sure you have a running MongoDB container on the same Docker network (--network some-network below). The Docker image defaults to mongodb://mongo:27017, so the MongoDB container must be reachable from the mongo-express container as mongo — start it with --name mongo or --network-alias mongo — unless you set ME_CONFIG_MONGODB_URL to a different hostname.

If MongoDB was initialized with MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD, include those credentials in ME_CONFIG_MONGODB_URL and authenticate against the admin database, for example mongodb://root:password@mongo:27017/?authSource=admin. ME_CONFIG_BASICAUTH_USERNAME and ME_CONFIG_BASICAUTH_PASSWORD only control the mongo-express web login; they are not used to authenticate to MongoDB.

Use the Docker Hub image:

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

Build from source:

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

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

Building with OIDC support:

To enable OIDC (OpenID Connect) authentication support in the Docker image, use the ENABLE_OIDC build argument:

$ docker build -t mongo-express --build-arg ENABLE_OIDC=true .
$ docker run -it --rm -p 8081:8081 --network some-network mongo-express

When ENABLE_OIDC=true is set, the express-openid-connect package will be installed during the build process, enabling OIDC authentication features.

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

| Name | Default | Description | ---------------------------------------------- | --------------------------------------------------- | - | ME_CONFIG_MONGODB_URL | mongodb://mongo:27017 | MongoDB connection string. Should include admin username and password if you want to enable admin access to all databases and see server statistics. When using the root user created by the official MongoDB image, add authSource=admin, for example mongodb://root:password@mongo:27017/?authSource=admin. If admin access is not enabled, it should also include database name (/defaultauthdb) to connect to. | ME_CONFIG_MONGODB_ENABLE_ADMIN | true | Enable administrator access. Send strings: "true" or "false". | ME_CONFIG_MONGODB_ALLOW_DISK_USE | false | Remove the limit of 100 MB of RAM on each aggregation pipeline stage. | ME_CONFIG_MONGODB_TLS | false | Use TLS client certificate | ME_CONFIG_MONGODB_TLS_ALLOW_CERTS | true | Validate mongod server certificate against CA | ME_CONFIG_MONGODB_TLS_CA_FILE | ` | CA certificate File (.pem) | ME_CONFIG_MONGODB_TLS_CERT_KEY_FILE | | TLS client certificate+key file (.pem) | ME_CONFIG_MONGODB_TLS_CERT_KEY_FILE_PASSWORD | | TLS client certificate key file password (.pem) | ME_CONFIG_MONGODB_TLS_CRL_FILE | | TLS certificate revocation list file (.pem) | ME_CONFIG_MONGODB_URL_FILE | | File version of ME_CONFIG_MONGODB_URL | ME_CONFIG_MONGODB_AWS_DOCUMENTDB | false | This 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 | /status | Set the mongo express healthcheck path. Remember to add the forward slash at the start. | ME_CONFIG_SITE_COOKIESECRET | | String used by cookie-parser middleware to sign cookies. | ME_CONFIG_SITE_SESSIONSECRET | | String used to sign the session ID cookie by express-session middleware. | ME_CONFIG_BASICAUTH | false | Deprecated, use ME_CONFIG_BASICAUTH_ENABLED instead. | ME_CONFIG_BASICAUTH_ENABLED | false | Enable Basic Authentication. Send strings: "true" or "false". | ME_CONFIG_AUTH_STRATEGY | | How visitors sign in: basic (browser prompt), form (sign-in page, works with password managers) or oidc. Unset, follows the flags below. | ME_CONFIG_BASICAUTH_USERNAME | admin | mongo-express web login name. | ME_CONFIG_BASICAUTH_USERNAME_FILE | | File version of ME_CONFIG_BASICAUTH_USERNAME | ME_CONFIG_BASICAUTH_PASSWORD | pass | mongo-express web login password. | ME_CONFIG_BASICAUTH_PASSWORD_FILE | | File version of ME_CONFIG_BASICAUTH_PASSWORD | ME_CONFIG_OIDCAUTH_ENABLED | false | Enable OpenIdConnect Authentication. Send strings: "true" or "false". | ME_CONFIG_OIDCAUTH_ISSUER | | OAuth2 Issuer. Root URL to the openidconnect metadata eg. "/.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. "/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_SIZE | 50 | Used to configure maximum Mongo update payload size in MB. CRUD operations above this size will fail due to restrictions in body-parser. | ME_CONFIG_OPTIONS_READONLY | false | if readOnly is true, components of writing are not visible. | ME_CONFIG_OPTIONS_FULLWIDTH_LAYOUT | false | If set to true an alternative page layout is used utilizing full window width. | ME_CONFIG_OPTIONS_PERSIST_EDIT_MODE | false | If set to true, remain on the same page after clicking on the Save button | ME_CONFIG_OPTIONS_NO_DELETE | false | If noDelete is true, components of deleting are not visible. | ME_CONFIG_OPTIONS_NO_RAW_COMMAND | false | If noRawCommand is true, the Raw tab in the collection view is not visible. | ME_CONFIG_OPTIONS_NO_EXPORT | false | If noExport is true, components of exporting are not visible. | ME_CONFIG_OPTIONS_CONFIRM_DELETE | false | If confirmDelete is set to 'true', a modal for confirming deletion is displayed | ME_CONFIG_OPTIONS_COLLAPSIBLE_JSON | true | If set to true, jsons will be displayed collapsible | ME_CONFIG_SITE_SSL_ENABLED | false | Enable SSL. | ME_CONFIG_SITE_SSL_CRT_PATH | | SSL certificate file. | ME_CONFIG_SITE_SSL_KEY_PATH | | SSL key file. | ME_CONFIG_SITE_GRIDFS_ENABLED | false | Enable gridFS to manage uploaded files. | ME_CONFIG_DOCUMENTS_PER_PAGE | 10 | How many documents you want to see at once in collection view | PORT | 8081 | port that mongo-express will run on. | VCAP_APP_HOST | localhost | address that mongo-express will listen on for incoming connections.

This example connects to a MongoDB container reachable as some-mongo on the Docker network and enables basic authentication in the mongo-express UI.

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).

• Git clone this repository
• Create a new or use already created MongoDB service
• Change the file examples/ibm-cloud/manifest.yml to fit your IBM Cloud app and service environment

Doing automatically:

• Click the button below to fork into IBM DevOps Services and deploy your own copy of this application on IBM Cloud

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

yarn add express-openid-connect

ME_CONFIG_OIDCAUTH_ENABLED=true
ME_CONFIG_OIDCAUTH_BASEURL=https://<domain>/<base-url>
ME_CONFIG_OIDCAUTH_ISSUER=<authority>
ME_CONFIG_OIDCAUTH_CLIENTID=<client-id>
ME_CONFIG_OIDCAUTH_CLIENTSECRET=<client-secret> # Optional
ME_CONFIG_OIDCAUTH_SECRET=<random-generated-string>
ME_CONFIG_SITE_COOKIESECRET=<client-secret>
ME_CONFIG_SITE_BASEURL=/<base-url>

// config.js
export default {
  mongodb: [
    {
      connectionString: 'mongodb://user:pass@mongo-a:27017/?authSource=admin',
      connectionName: 'reporting',
      admin: true,
    },
    {
      connectionString: 'mongodb://user:pass@mongo-b:27017/orders',
      connectionName: 'orders',
    },
  ],
};

• Documents must have the document._id property to be edited
• Binary BSON data type not tested

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

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

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

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

Example: Timestamp(ISODate(), 0)`.

See https://www.mongodb.com/docs/mongodb-shell/reference/data-types/#timestamp for more info about the Timestamp data type.

Code

Code(code)

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

Specifying a scope/context is not supported.

MinKey

MinKey()

MaxKey

MaxKey()

Symbol

Symbol(string)

Example Document

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

{ "_id": ObjectId(), "dates": { "date": ISODate("2012-05-14T16:20:09.314Z"), "new_date": ISODate(), "alternative": new Date() }, "photo": "data:image/jpeg;base64,/9j/4...", "video": "data:video/webm;base64,GkXfo...", "audio": "data:audio/ogg;base64,T2dnUw...", "bool": true, "string": "hello world!", "list of numbers": [ 123, 111e+87, 4.4, -12345.765 ], "reference": DBRef("collection", "4fb1299686a989240b000001"), "ts": Timestamp(ISODate(), 1), "minkey": MinKey(), "maxkey": MaxKey(), "func": Code(function() { alert('Hello World!') }), "symbol": Symbol("test") }