To run both RESTHeart and MongoDB services you can use docker compose. Just copy and paste the following shell command:

Standalone mode runs RESTHeart without MongoDB. Learn more about when to use standalone mode.

This runs RESTHeart with Docker connecting to MongoDB running on the localhost.

If MongoDB is not already running, the following command will start a replica set and initiate it (the replica set is not required but enables RESTHeart to support transactions and change streams). Note that the data path is /tmp/db.

Run RESTHeart with:

This configuration uses a Docker network to isolate RESTHeart and MongoDB:

Use this setup for: - Learning production deployment patterns - Testing security configurations - Development environments needing network isolation # Setup Procedure

You only need to complete this setup once. Follow these steps:

1) Create a Docker Network

Create a dedicated network for RESTHeart and MongoDB communication:

2) Start MongoDB Container

Launch a MongoDB container within the created network:

3) Initialize MongoDB as a Single Node Replica Set

Initialize the MongoDB instance to work as a single node replica set:

4) Launch RESTHeart Container

Run the RESTHeart container, linking it to the MongoDB container:

Command breakdown: - --network restheart-network - Connects to the isolated network - -p "8080:8080" - Exposes RESTHeart’s API port - --rm - Automatically removes container on stop (stateless) - -e RHO='…​' - Configures MongoDB connection string to use hostname mongodb (the container name)

5) Test the Setup

Execute a test request to verify that RESTHeart is running:

To stop both RESTHeart and MongoDB containers, use the following command:

The RESTHeart container is stateless and is removed upon stopping (due to the --rm option). However, the MongoDB container retains its state and is not removed on stop. To restart, use the following commands:

1) Start MongoDB Container

2) Run RESTHeart Container

You only need to complete this setup once. Follow these steps:

1) Start MongoDB Container

Launch a MongoDB container:

2) Initialize MongoDB as a Single Node Replica Set

Initialize the MongoDB instance to work as a single node replica set:

3) Launch RESTHeart Container

Run the RESTHeart container, linking it to the MongoDB container:

4) Test the Setup

Execute a test request to verify that RESTHeart is running:

To stop both RESTHeart and MongoDB containers, use the following command:

The RESTHeart container is stateless and is removed upon stopping (due to the --rm option). However, the MongoDB container retains its state and is not removed on stop. To restart, use the following commands:

1) Start MongoDB Container

2) Run RESTHeart Container

If the plugin jar file is in the directory ./target, this command starts RESTHeart with the plugin integrated:

How this works: - -v ./target:/opt/restheart/plugins/custom mounts your local ./target directory - RESTHeart scans /opt/restheart/plugins/ on startup - Your plugin JAR files in ./target will be loaded automatically

Requirements: - Plugin JAR must be in ./target on your host machine - RESTHeart version must be >= 7.7

This runs RESTHeart enabling remote debugging (port 4000).

RESTHeart Docker images come in four different versions:

The "distroless" images are for special deployment requirements, where having the smallest possible image size and the very minimal security attack surface is required and their tag contains a distroless label. You usually don’t need these images unless you exactly know what you are doing.

Images tags ending with -native are created with the GraalVM Native Image technology starting from stable builds of the product, especially suited for high demanding environments, like Kubernetes. These are experimental and not fully documented yet, please contact us for questions.