Skip to content

Local Install documentation changes #545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Gonthim wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Local Install documentation changes #545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,12 +152,14 @@ The first user account created is automatically given admin powers. Thereafter,
Local installation
-------------

### Minimum System / VM Spec ###
It doesn't take much to get started. 2 cores / 4gb ram / 10gb storage. Less ram will cause docker compose build errors.

### With Docker Compose

DM3 can be installed quickly using Docker Compose. The only requirements are [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) themselves.
DM3 can be installed quickly using Docker Compose. The only requirements are [GIT](https://git-scm.com/install/) and [Docker](https://docs.docker.com/engine/install/#installation-procedures-for-supported-platforms). Current (02/01/2026) Docker install instructions for all platforms include the 'docker-compose-plugin', but in case they change it is required.

First, clone the repo from GitHub, `cd` into the repo directory, and copy the sample environment variables into `.env` and `config/application.yml`.
Once you have GIT and Docker CE installed, clone the repo from GitHub, `cd` into the repo directory, and copy the sample environment variables into `.env` and `config/application.yml`.

```sh
git clone https://github.com/performant-software/dm-2.git
Expand Down Expand Up @@ -194,7 +196,7 @@ If you wish to mount the code directory from your local filesystem onto the Dock
docker compose -f docker-compose.yml -f docker-compose.dev.yml up
```

After boot completes, the app should be up and running on `localhost:3000`.
After boot completes, the app should be up and running on `localhost:3001`.

You may stop the application at any time by opening another shell in the same `dm-2` directory and running:
```sh
Expand Down