Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fscm/docker-mongodb

Docker recipe to build an MongoDB image
https://github.com/fscm/docker-mongodb

docker docker-image dockerfile mongodb

Last synced: 13 days ago
JSON representation

Docker recipe to build an MongoDB image

Awesome Lists containing this project

README 

        
# MongoDB for Docker



Docker image with MongoDB.



## Synopsis



This script will create a Docker image with MongoDB installed and with all

of the required initialization scripts.



The Docker image resulting from this script should be the one used to

instantiate a MongoDB server.



## Getting Started



There are a couple of things needed for the script to work.



### Prerequisites



Docker, either the Community Edition (CE) or Enterprise Edition (EE), needs to

be installed on your local computer.



#### Docker



Docker installation instructions can be found

[here](https://docs.docker.com/install/).



### Usage



In order to create a Docker image using this Dockerfile you need to run the

`docker` command with a few options.



```shell

docker image build --force-rm --no-cache --quiet --tag /: 

```



- `` - *[required]* The user that will own the container image (e.g.: "johndoe").

- `` - *[required]* The container name (e.g.: "mongodb").

- `` - *[required]* The container tag (e.g.: "latest").

- `` - *[required]* The location of the Dockerfile folder.



A build example:



```shell

docker image build --force-rm --no-cache --quiet --tag johndoe/my_mongodb:latest .

```



To clean any _`none`_ image(s) left by the build process the following

command can be used:



```shell

docker image rm `docker image ls --filter "dangling=true" --quiet`

```



You can also use the following command to achieve the same result:



```shell

docker image prune -f

```



### Instantiate a Container



In order to end up with a functional MongoDB service - after having build

the container - some configurations have to be performed.



To help perform those configurations a small set of commands is included on the

Docker container.



- `help` - Usage help.

- `init` - Configure the MongoDB service (__Not required in this image__).

- `start` - Start the MongoDB service.



To store the data of the MongoDB server a volume should be created and added

to the container when running the same.



#### Creating Volumes



To be able to make all of the MongoDB data persistent, the same will have to

be stored on a different volume.



Creating volumes can be done using the `docker` tool. To create a volume use

the following command:



```shell

docker volume create --name 

```



Two create the required volume the following command can be used:



```shell

docker volume create --name my_mongodb

```



**Note:** A local folder can also be used instead of a volume. Use the path of

the folder in place of the volume name.



#### Configuring the MongoDB Server



This step is not required for this MongoDB Docker image.



#### Start the MongoDB Server



After configuring the MongoDB server the same can now be started.



Starting the MongoDB server can be done with the `start` command.



```shell

docker container run --volume :/data:rw --detach --publish 27017:27017 /: start

```



To help managing the container and the MongoDB instance a name can be given

to the container. To do this use the `--name ` docker option when

starting the server



An example on how the MongoDB service can be started:



```shell

docker container run --volume my_mongodb:/data/mongodb:rw --detach --publish 27017:27017 --name my_mongodb johndoe/my_mongodb:latest start

```



To see the output of the container that was started use the following command:



```shell

docker container attach 

```



Use the `ctrl+p` `ctrl+q` command sequence to detach from the container.



#### Stop the MongoDB Server



If needed the MongoDB server can be stoped and later started again (as long as

the command used to perform the initial start was as indicated before).



To stop the server use the following command:



```shell

docker container stop 

```



To start the server again use the following command:



```shell

docker container start 

```



### MongoDB Status



The MongoDB server status can be check by looking at the MongoDB server output

data using the docker command:



```shell

docker container logs 

```



### Add Tags to the Docker Image



Additional tags can be added to the image using the following command:



```shell

docker image tag  /:

```



### Push the image to Docker Hub



After adding an image to Docker, that image can be pushed to a Docker registry... Like Docker Hub.



Make sure that you are logged in to the service.



```shell

docker login

```



When logged in, an image can be pushed using the following command:



```shell

docker image push /:

```



Extra tags can also be pushed.



```shell

docker image push /:

```



## Contributing



1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request



Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more details on how

to contribute to this project.



## Versioning



This project uses [SemVer](http://semver.org/) for versioning. For the versions

available, see the [tags on this repository](https://github.com/fscm/docker-mongodb/tags).



## Authors



- **Frederico Martins** - [fscm](https://github.com/fscm)



See also the list of [contributors](https://github.com/fscm/docker-mongodb/contributors)

who participated in this project.



## License



This project is licensed under the MIT License - see the [LICENSE](LICENSE)

file for details