Mortar has joined Datadog, the leading SaaS-based monitoring service for cloud applications. Read more about what this means here.

Setup Your Project

All code that runs using the Mortar framework is contained in git-backed Mortar projects. The first step in running an example is to setup a project.

Public vs Private

Mortar Projects come in two flavors: Public and Private. Public Mortar Projects can be viewed and forked by anyone. Private Mortar Projects are only accessible to users in your Mortar account. When creating a new project you will need to decide if this is code that you would like to share with the world or if this is code that you want to keep within your organization.

Create your project

To allow you to get started quickly we have created a base MongoDB project that you can fork to create your own project. This project contains a number of runnable examples and templates. The base Mortar project is open source and hosted in Github at

Mortar Projects share one global namespace, and so each project must have a unique name. If you want to keep your project private, remove the "public" flag from the command below.

mortar projects:fork <your_project_name> --public

To read more about Mortar projects see How Mortar Projects Work.

This project is now in your Mortar account. If in the future you want to get updates made to Mortar's version of mortar-mongo-examples, use:

git fetch base
git merge base/master

And that's it! You now have all of the code forked into your own Mortar project, ready to start the next step of running an example script.