README.md

# MITRE Heimdall2

Given that Heimdall requires at least a database service, we use Docker and Docker Compose to provide a simple deployment experience.

#### Setup Docker Container (Clean Install)

1. Install Docker

2. Download and extract the most recent `docker-compose.yml` and `setup-docker-secrets.sh` from our [releases page](https://github.com/mitre/heimdall2/releases).

3. Navigate to the base folder where `docker-compose.yml` is located

4. Run the following commands in a terminal window from the Heimdall source directory. For more information on the .env file, visit [Environment Variables Configuration.](https://github.com/mitre/heimdall2/wiki/Environment-Variables-Configuration)
   - ```bash
     ./setup-docker-secrets.sh
     # If you would like to further configure your Heimdall instance, edit the .env file generated after running the previous line
     docker-compose up -d
     ```

6. Navigate to  [`http://127.0.0.1:3000`](http://127.0.0.1:3000).

#### Running Docker Container

Make sure you have run the setup steps at least once before following these steps!

1. Run the following command in a terminal window: ``docker-compose up -d``

2. Go to [`http://127.0.0.1:3000`](http://127.0.0.1:3000) in a web browser.

#### Updating Docker Container

A new version of the docker container can be retrieved by running:

```bash
docker-compose pull
docker-compose up -d
```

This will fetch the latest version of the container, redeploy if a newer version exists, and then apply any database migrations if applicable. No data should be lost by this operation.

#### Stopping the Container

From the source directory you started from run:

```bash
docker-compose down
```