nfrastack/container-mongo

About

This repository will build a container for mongo. A ..

Maintainer

• Nfrastack

Table of Contents

• About
• Maintainer
• Table of Contents
• Installation
  • Prebuilt Images
  • Quick Start
  • Persistent Storage
• Environment Variables
  • Base Images used
  • Core Configuration
• Users and Groups
  • Networking
• Maintenance
  • Shell Access
• Support & Maintenance
• License

Installation

Prebuilt Images

Feature limited builds of the image are available on the Github Container Registry and Docker Hub.

To unlock advanced features, one must provide a code to be able to change specific environment variables from defaults. Support the development to gain access to a code.

To get access to the image use your container orchestrator to pull from the following locations:

ghcr.io/nfrastack/container-mongo:(image_tag)
docker.io/nfrastack/mongo:(image_tag)

Image tag syntax is:

<image>:<branch>-<optional tag>-<optional_distribution>_<optional_distribution_variant>

Example:

ghcr.io/nfrastack/container-mongo:7 or

ghcr.io/nfrastack/container-mongo:latest or

ghcr.io/nfrastack/container-mongo:7-1.0 or

• latest will be the most recent mongo version and commit
• branch will be the repositories branch, typically matching with the version of mongo eg 7
• An optional tag may exist that matches the CHANGELOG - These are the safest
• If there are multiple distribution variations it may include a version - see the registry for availability

Have a look at the container registries and see what tags are available.

Multi-Architecture Support

Images are built for amd64 by default, with optional support for arm64 and other architectures.

Quick Start

• The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for your use.

• Map persistent storage for access to configuration and data files for backup.

• Set various environment variables to understand the capabilities of this image.

Persistent Storage

The following directories are used for configuration and can be mapped for persistent storage.

Directory	Description
/data/db/	Database Files
/logs/	Logfiles

Environment Variables

Base Images used

This image relies on a customized base image in order to work. Be sure to view the following repositories to understand all the customizable options:

Image	Description
OS Base	Base Image

Below is the complete list of available options that can be used to customize your installation.

• Variables showing an 'x' under the Advanced column can only be set if the containers advanced functionality is enabled.

Core Configuration

Parameter	Description	Default	_FILE	Advanced
SETUP_MODE	Auto configure based on environment variables AUTO or MANUAL	AUTO
ADDITIONAL_PARAMETERS	Pass additional parameters to the mongod process (works with SETUP_MODE=MANUAL)
CONFIG_FILE	Map and use a config file. Works with both SETUP_MODE values.
	All environment variables override config file
ENABLE_AUTHENTICATION	Enable Authentication Features	FALSE
LOG_PATH	Log Path	/logs
LOG_TYPE	Write to FILE	FILE
ADMIN_NAME	Administrator Account name	admin	x
ADMIN_PASS	Password of Admin user	admin	x
DATA_PATH	Data Location	/data/db
DB_NAME	Name of Database to create	admin	x
DB_USER	Name of DB User to create if DB_NAME not admin		x
DB_PASS	Password of DB User to create if DB_NAME not admin
DB_PORT	MongoDB Listening Port	27017
ENABLE_JOURNALING	Enable Journaling TRUE FALSE	TRUE
MAX_CONNECTIONS	Maximum Connections
OPLOG_SIZE	OPLog Size
SKIP_INIT	Skip creating databases and admin users if used in a replica set	FALSE
ENABLE_REPLICATION	Enable Replication	FALSE
REPLICATION_SET	Name of Replication Set	rs0
REPLICATION_INIT	Initialize the Replica set
REPLICATION_HOSTS	Comma seperated list of hosts to init the replica set	0:localhost:$DB_PORT:1
	Syntax is id:hostname:port:priority

Users and Groups

Type	Name	ID
User	mongo	27017
Group	mongo	27017

Networking

Port	Protocol	Description
27017	tcp	Mongo Daemon
28017	tcp	Mongo Daemon

---

Maintenance

Shell Access

For debugging and maintenance, bash and sh are available in the container.

Support & Maintenance

• For community help, tips, and community discussions, visit the Discussions board.
• For personalized support or a support agreement, see Nfrastack Support.
• To report bugs, submit a Bug Report. Usage questions will be closed as not-a-bug.
• Feature requests are welcome, but not guaranteed. For prioritized development, consider a support agreement.
• Updates are best-effort, with priority given to active production use and support agreements.

License

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