Docker Mongo Express Setup

This repository provides an easy-to-use solution for deploying Mongo Express to manage and visualize your MongoDB data inside a Docker container. It includes user-friendly PowerShell and Bash scripts to automate the process of setting up Mongo Express with customizable parameters.

Features

1. Environment File Generation: Automatically generates a .env file with user-defined parameters such as container name, network name, port, and credentials.
2. Docker Network Management: Creates a Docker network if it doesn’t already exist.
3. Docker Compose Configuration: Dynamically generates a docker-compose.yaml file from a docker-compose.example.yaml template.
4. Build and Run: Executes docker-compose up -d --build to build and start the Mongo Express container.
5. Container Status Check: Checks the container status post-deployment.
6. Error Handling: Automatically displays logs if the container fails to start.

Prerequisites

• Docker must be installed and running on your system.
• Docker Compose must be installed.
• Linux Only: Ensure dos2unix is installed to handle line ending conversions if needed.

  sudo apt install dos2unix

• Git must be installed and available in your system's PATH.

  sudo apt install git       # For Debian/Ubuntu
  sudo yum install git       # For CentOS/RHEL
  brew install git           # For macOS

• Windows PowerShell (Admin) or a Bash-compatible terminal for script execution.

Installation Steps

One Command Install and Clone

Windows

Open PowerShell as Administrator and run:

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass; git clone https://github.com/amir377/docker-mongo-express-setup; cd docker-mongo-express-setup; ./install.ps1

Linux/Mac

Run the following command in your terminal:

git clone https://github.com/amir377/docker-mongo-express-setup && cd docker-mongo-express-setup && dos2unix install.sh && chmod +x install.sh && ./install.sh

Manual Installation

1. Clone the repository:

   git clone https://github.com/amir377/docker-mongo-express-setup.git
   cd docker-mongo-express-setup

2. Place your docker-compose.example.yaml file in the root directory (if not already provided).

3. Run the appropriate installation script:

   • For Windows: install.ps1
   • For Linux/Mac: install.sh

4. Follow the prompts to customize your setup:

   • Container name
   • Network name
   • Mongo Express port
   • MongoDB credentials

File Descriptions

install.ps1

Automates the entire setup process for Windows, including:

• Generating .env and docker-compose.yaml files.
• Ensuring Docker and Docker Compose are installed.
• Creating the specified Docker network.
• Building and starting the Mongo Express container.
• Providing access to the container logs if needed.

install.sh

Automates the setup process for Linux/Mac, including:

• Generating .env and docker-compose.yaml files.
• Ensuring Docker and Docker Compose are installed.
• Creating the specified Docker network.
• Building and starting the Mongo Express container.

.env

Holds configuration values for the Mongo Express container. Example:

# MONGODB container settings
CONTAINER_NAME=mongo-express
NETWORK_NAME=general
MONGO_EXPRESS_PORT=8081
ALLOW_HOST=0.0.0.0

# MONGODB credentials
ME_CONFIG_MONGODB_ADMINUSERNAME=admin
ME_CONFIG_MONGODB_ADMINPASSWORD=admin123
ME_CONFIG_MONGODB_SERVER=mongodb
ME_CONFIG_BASICAUTH_USERNAME=user
ME_CONFIG_BASICAUTH_PASSWORD=pass

docker-compose.example.yaml

A template file for the docker-compose.yaml file. Placeholders are dynamically replaced with values from the .env file. Example:

services:
  mongo-express:
    image: mongo-express:latest
    container_name: ${CONTAINER_NAME}
    environment:
      ME_CONFIG_MONGODB_ADMINUSERNAME: ${ME_CONFIG_MONGODB_ADMINUSERNAME}
      ME_CONFIG_MONGODB_ADMINPASSWORD: ${ME_CONFIG_MONGODB_ADMINPASSWORD}
      ME_CONFIG_MONGODB_SERVER: ${ME_CONFIG_MONGODB_SERVER}
      ME_CONFIG_BASICAUTH_USERNAME: ${ME_CONFIG_BASICAUTH_USERNAME}
      ME_CONFIG_BASICAUTH_PASSWORD: ${ME_CONFIG_BASICAUTH_PASSWORD}
    ports:
      - "${ALLOW_HOST}:${MONGO_EXPRESS_PORT}:8081"
    networks:
      - ${NETWORK_NAME}

networks:
  ${NETWORK_NAME}:
    external: true

docker-compose.yaml

Generated file used to deploy the Mongo Express container with Docker Compose.

Usage

Accessing Mongo Express

• Host: The ALLOW_HOST value specified during setup (default: 0.0.0.0)
• Port: The MONGO_EXPRESS_PORT value specified during setup (default: 8081)
• Admin Username: The ME_CONFIG_MONGODB_ADMINUSERNAME value specified during setup
• Admin Password: The ME_CONFIG_MONGODB_ADMINPASSWORD value specified during setup

Viewing Logs

If the container fails to start, the script will display logs automatically:

docker logs <container-name>

Accessing the Container Shell

If you need to access the Mongo Express container shell:

docker exec -it <container-name> bash

Notes

• Ensure Docker is running before executing the script.
• If you encounter permission issues, run PowerShell or Bash as Administrator.
• Update the docker-compose.example.yaml file to suit your specific requirements.

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Feel free to customize the script or template files to fit your specific use case!