Skip to content

Latest commit

 

History

History
122 lines (80 loc) · 3.32 KB

README.md

File metadata and controls

122 lines (80 loc) · 3.32 KB
Raw

mongo-express

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

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

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)
  • BSON data types are not all working correctly (Do not use mongo-express for editing complex docs for now!)

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 config.default.js into a new file called config.js.

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

To run:

node app

To use:

Visit http://localhost:8081 or whatever URL/port you entered into your config.

BSON Data Types

Not all BSON data types are working correctly. This means that mongo-express cannot display or add these data types.

The currently working data types:

  • Native Javascript types: strings, numbers, floats, lists, booleans, null, etc.
  • ObjectID: can also use ObjectId
  • ISODate: Do not use Date, use ISODate

Not tested (probably broken):

  • Long/NumberLong
  • Double/NumberDouble (gets converted to Javascript number type)
  • Timestamp
  • DBRef
  • Binary/BinData
  • Code
  • Symbol
  • MinKey
  • MaxKey

Here is an example of how to use them:

{
  "_id": ObjectID(), // or ObjectId()
  "date": ISODate("2012-05-14T16:20:09.314Z"),
  "new_date": ISODate(),
  "bool": true,
  "string": "hello world!",
  "list of numbers": [
    123,
    1234566789,
    4.4,
    -12345.765
  ]
}

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.