bitnami/mongodb repository overview

⁠MongoDB® packaged by Bitnami

Overview of MongoDB®⁠ Disclaimer: The respective trademarks mentioned in the offering are owned by the respective companies. We do not provide a commercial license for any of these products. This listing has an open-source license. MongoDB(R) is run and maintained by MongoDB, which is a completely separate project from Bitnami.

⁠ TL;DR

docker run --name mongodb REGISTRY_NAME/bitnami/mongodb:latest

⁠ How to deploy MongoDB® in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami MongoDB® Chart GitHub repository⁠.

⁠ Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs⁠.

⁠ Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page⁠.

⁠ Get this image

The recommended way to get the Bitnami MongoDB® Docker Image is to pull the prebuilt image from the Docker Hub Registry⁠.

docker pull REGISTRY_NAME/bitnami/mongodb:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions⁠ in the Docker Hub Registry.

docker pull REGISTRY_NAME/bitnami/mongodb:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t REGISTRY_NAME/bitnami/APP:latest .

⁠ Using docker-compose.yaml

Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart⁠.

⁠ Persisting your database

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /bitnami/mongodb path. If the mounted directory is empty, it will be initialized on the first run.

⁠ Connecting to other containers

Using Docker container networking⁠, a MongoDB® server running inside a container can easily be accessed by your application containers.

Containers attached to the same network can communicate with each other using the container name as the hostname.

⁠ Configuration

The following section describes the supported environment variables

⁠ Environment variables

The following tables list the main variables you can set.

⁠Customizable environment variables

⁠Read-only environment variables

⁠ Initializing a new instance

When the container is executed for the first time, it will execute the files with extensions .sh, and .js located at /docker-entrypoint-initdb.d.

In order to have your custom files inside the docker image you can mount them as a volume.

⁠ Passing extra command-line flags to mongod startup

Passing extra command-line flags to the mongod service command is possible through the following env var:

• MONGODB_EXTRA_FLAGS: Flags to be appended to the mongod startup command. No defaults
• MONGODB_CLIENT_EXTRA_FLAGS: Flags to be appended to the mongo command which is used to connect to the (local or remote) mongod daemon. No defaults

⁠ Configuring system log verbosity level

Configuring the system log verbosity level is possible through the following env vars:

• MONGODB_DISABLE_SYSTEM_LOG: Whether to enable/disable system log on MongoDB®. Default: false. Possible values: [true, false].
• MONGODB_SYSTEM_LOG_VERBOSITY: MongoDB® system log verbosity level. Default: 0. Possible values: [0, 1, 2, 3, 4, 5]. For more information about the verbosity levels please refer to the MongoDB® documentation⁠

⁠ Using numactl

In order to enable launching commands using numactl, set the MONGODB_ENABLE_NUMACTL variable to true. For more information on this, check the official [MongoDB documentation][(https://docs.mongodb.com/manual/administration/production-notes/#configuring-numa-on-linux⁠)

⁠ Enabling/disabling IPv6

Enabling/disabling IPv6 is possible through the following env var:

• MONGODB_ENABLE_IPV6: Whether to enable/disable IPv6 on MongoDB®. Default: false. Possible values: [true, false]

⁠ Enabling/disabling directoryPerDB

Enabling/disabling directoryPerDB⁠ is possible through the following env var:

• MONGODB_ENABLE_DIRECTORY_PER_DB: Whether to enable/disable directoryPerDB on MongoDB®. Default: true. Possible values: [true, false]

⁠ Enabling/disabling journaling

Enabling/disabling journal⁠ is possible through the following env var:

• MONGODB_ENABLE_JOURNAL: Whether to enable/disable journaling on MongoDB®. Default: true. Possible values: [true, false]

⁠ Setting the root user and password on first run

Passing the MONGODB_ROOT_PASSWORD environment variable when running the image for the first time will set the password of MONGODB_ROOT_USER to the value of MONGODB_ROOT_PASSWORD and enable authentication on the MongoDB® server. If unset, MONGODB_ROOT_USER defaults to root.

The MONGODB_ROOT_USER user is configured to have full administrative access to the MongoDB® server. When MONGODB_ROOT_PASSWORD is not specified the server allows unauthenticated and unrestricted access.

⁠ Creating a user and database on first run

You can create a user with restricted access to a database while starting the container for the first time. To do this, provide the MONGODB_USERNAME, MONGODB_PASSWORD and MONGODB_DATABASE environment variables.

⁠ Setting up replication

A replication⁠ cluster can easily be setup with the Bitnami MongoDB® Docker Image using the following environment variables:

• MONGODB_REPLICA_SET_MODE: The replication mode. Possible values primary/secondary/arbiter. No defaults.
• MONGODB_REPLICA_SET_NAME: MongoDB® replica set name. Default: replicaset
• MONGODB_PORT_NUMBER: The port each MongoDB® will use. Default: 27017
• MONGODB_INITIAL_PRIMARY_HOST: MongoDB® initial primary host, once the replicaset is created any node can be eventually promoted to be the primary. No defaults.
• MONGODB_INITIAL_PRIMARY_PORT_NUMBER: MongoDB® initial primary node port, as seen by other nodes. Default: 27017
• MONGODB_ADVERTISED_HOSTNAME: MongoDB® advertised hostname. No defaults. It is recommended to pass this environment variable if you experience issues with ephemeral IPs. Setting this env var makes the nodes of the replica set to be configured with a hostname instead of the machine IP.
• MONGODB_ADVERTISE_IP: MongoDB® advertised hostname is set to container ip. Default: false. Overrides MONGODB_ADVERTISED_HOSTNAME
• MONGODB_ADVERTISED_PORT_NUMBER: MongoDB® advertised port number. No defaults. It is recommended to pass this environment variable if you have a proxy port forwarding requests to container.
• MONGODB_REPLICA_SET_KEY: MongoDB® replica set key. Length should be greater than 5 characters and should not contain any special characters. Required for all nodes. No default.
• MONGODB_ROOT_USER: MongoDB® root user name. Default: root.
• MONGODB_ROOT_PASSWORD: MongoDB® root password. No defaults. Only for primary node.
• MONGODB_INITIAL_PRIMARY_ROOT_PASSWORD: MongoDB® initial primary root password. No defaults. Only for secondaries and arbiter nodes.

In a replication cluster you can have one primary node, zero or more secondary nodes and zero or one arbiter node.

⁠How is a replica set configured?

There are four different roles in a replica set configuration (primary, secondary, hidden or arbiter). Each one of these roles are configured in a different way:

Primary node configuration:

The replica set is started with the rs.initiate() command and some configuration options to force the primary to be the primary. Basically, the priority is increased from the default (1) to

Note: the README for this container is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://techdocs.broadcom.com/us/en/vmware-tanzu/bitnami-secure-images/bitnami-secure-images/services/bsi-app-doc/apps-containers-mongodb-index.html⁠