README

mongo-express

   


A web-based admin interface for MongoDB or compatible services (FerretDB, Amazon DocumentDB). Built with Node.js, Express, and Bootstrap 5.

 Features

- Connect to multiple databases
- View/add/delete databases
- View/add/rename/delete collections
- View/add/update/delete documents
- Preview audio/video/image assets inline in the collection view
- Nested and/or large objects are collapsible for easy overview
- Async on-demand loading of big document properties (100KB default) to keep collection view fast
- GridFS support - add/get/delete incredibly large files
- Use BSON data types in documents
- Mobile / Responsive - Bootstrap 5 works passably on small screens when you're in a bind
- Connect and authenticate to individual databases
- Authenticate as admin to view all databases
- Database blacklist/whitelist
- Custom CA/TLS/SSL and CA validation disabling
- Supports replica sets
- OpenIdConnect Authentication

 Screenshots

| Home Page | Database View | Collection View | Editing A Document
| - | - | - | -
|  |  |  | 

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