mongo-express

mongo-express

Web-based MongoDB admin interface written with Node.js and express

- Master (stable) branch

- Develop branch

Features

Current features:

• Connect to multiple databases
• Connect and authenticate to individual databases
• Authenticate as admin to view all databases
• Database blacklist/whitelist
• View/add/rename/delete collections
• View/add/update/delete documents
• Use BSON data types in documents
• Ability to specify the default key to be shown in the docs list.

Planned features:

• Support for replica set connections
• Web-based command-line interface
• Site authentication
• REST interface

Limitations

• Documents must have document._id property to be edited
• No GridFS support (might become a planned feature)
• Binary BSON data type not tested

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

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

Screenshots

Click here for more screenshots: http://imgur.com/a/OTZHe

These screenshots are from version 0.11.0.

Usage

To install:

npm install mongo-express

Or if you want to install a global copy:

npm install -g mongo-express

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: Populate the defaultKeyNames field with your database names, collection names and the key name to be displayed by default in the documents list of collections page.

For example :

    defaultKeyNames:{
    	"world_db":{  //Database 1 Name
    		"continent":"cont_name", // collection:feild
    		"country":"country_name",
    		"city":"name"
    	},
    	... // Database 2
    	... // Database 3
    }

If no key name is specified for a collection, it defaults to '_id'.

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.

To run:

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

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

var
    express = require('express')
  , http = require('http')
  ;

var
    config = require('./config')
  , middleware = require('./middleware')
  ;

var app = express();
app.use('/your-mountpath', middleware(config));
app.listen(config.site.port, function() {
  console.log("Mongo Express server listening on port " + (config.site.port || 80));
});

To run as a Docker container:

First, build the container from the project directorty:

docker build -t mongo-express .

If you have a running MongoDB container:

docker run -d -p 8081:8081 --link mongodb:mongodb mongo-express

You can use the following environment variables:

• Variable name: ME_CONFIG_MONGODB_SERVER

• Description: MongoDB host name or IP address.

• Default value: localhost

• Variable name: ME_CONFIG_MONGODB_PORT

• Description: MongoDB port.

• Default value: 27017

• Variable name: ME_CONFIG_MONGODB_ADMINUSERNAME

• Description: Administrator username.

• Default value: ``

• Variable name: ME_CONFIG_MONGODB_ADMINPASSWORD

• Description: Administrator password.

• Default value: ``

• Variable name: ME_CONFIG_SITE_COOKIESECRET

• Description: String used by cookie-parser middleware to sign cookies.

• Default value: cookiesecret

• Variable name: ME_CONFIG_SITE_SESSIONSECRET

• Description: String used to sign the session ID cookie by express-session middleware.

• Default value: sessionsecret

• Variable name: ME_CONFIG_BASICAUTH_USERNAME

• Description: mongo-express login name. Sending an empty string will disable basic authentication.

• Default value: admin

• Variable name: ME_CONFIG_BASICAUTH_PASSWORD

• Description: mongo-express login password.

• Default value pass

• Variable name: ME_CONFIG_OPTIONS_EDITORTHEME

• Description: Web editor color theme.

• Default value: rubyblue

To use:

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

BSON Data Types

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

Native Javascript Types

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

All numbers in Javascript are 64-bit floating points.

ObjectID/ObjectId

ObjectID()

Creates a new Object ID type.

ObjectID(id)

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

ISODate

ISODate()

Creates a new ISODate object with current time.

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

ISODate(timestamp)

Uses ISODate object with the given timestamp.

DBRef/Dbref

DBRef(collection, objectID)

DBRef(collection, objectID, database)

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

The database value is optional.

Timestamp

Timestamp()

Creates a new Timestamp object with a value of 0.

Timestamp(time, ordinal)

Example: Timestamp(ISODate(), 0).

See http://www.mongodb.org/display/DOCS/Timestamp+data+type 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)

---

Not tested:

• Binary/BinData

Here is an example of a document which can be read/edited in mongo-express:

{
  "_id": ObjectID(), // or ObjectId()
  "dates": {
    "date": ISODate("2012-05-14T16:20:09.314Z"),
    "new_date": ISODate(),
    "alternative": new Date()
  },
  "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")
}

License

MIT License

Copyright (c) 2012 Chun-hao Hu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.