Installation Guide

MongoMan can be installed and run either using Docker or by building from source.

Docker Installation

Using docker-compose

Create a docker-compose.yml file:

version: '3'
services:
  mongoman:
    image: ghcr.io/aientech/mongoman:main
    environment:
      - MONGODB_URI=mongodb://mongo:27017
    ports:
      - '3000:3000'

Then run:

docker-compose up -d

Using Docker directly

docker run -p 3000:3000 -e MONGODB_URI=mongodb://mongo:27017 ghcr.io/aientech/mongoman:main

Local Installation

Prerequisites

• Node.js
• Yarn or npm
• MongoDB instance (local or remote)

Steps

1. Clone the repository:

git clone git@github.com:AienTech/mongoman.git

1. Navigate to project directory:

cd mongoman

1. Install dependencies:

yarn install

1. Set up environment variables:

cp .env.example .env.local

1. Edit .env.local and set your MongoDB connection string:

MONGODB_URI=mongodb://localhost:27017

1. Start the development server:

yarn dev

Building from Source

To build the Docker image yourself:

docker build --build-arg MONGODB_URI=mongodb://temporary:27017 -t mongoman .

Environment Variables

Variable	Description	Example
MONGODB_URI	MongoDB connection string	mongodb://localhost:27017

Verifying Installation

After installation:

1. Open your browser and navigate to http://localhost:3000
2. You should see the MongoMan interface
3. The dashboard will display your MongoDB connection status