Skip to content

Commit

Permalink
docs: Update README.md with instructions on using the docker composition
Browse files Browse the repository at this point in the history
Signed-off-by: Alf-Rune Siqveland <alf.rune@northern.tech>
  • Loading branch information
alfrunes committed Oct 8, 2024
1 parent 6bbe598 commit c9aa7dc
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,54 @@
# mender-server
Mender Server monorepo

## Getting started

Before you start the Mender server, make sure you have [Docker Compose](https://docs.docker.com/compose/install/) installed.
Mender server requires Docker Compose version `v2.21.0` or newer.
```
docker compose version
```

> [!NOTE]
> This docker composition is only meant for evaluation purposes.
> Please use [the helm chart](https://github.com/mendersoftware/mender-helm) in production environments.
To start evaluating Mender, you can bring up your Mender server by running:
```
docker compose up -d
```

Once all containers are running, you can create your initial user using the following command:
```
MENDER_USERNAME=admin@mender.local
MENDER_PASSWORD=password123
docker compose exec useradm useradm create-user --username "$MENDER_USERNAME" --password "$MENDER_PASSWORD"
```

Visit [https://localhost](https://localhost) and sign in using the credentials from the snippet above.

### Evaluating Mender enterprise

> [!WARNING]
> We strongly advise using [the helm chart](https://github.com/mendersoftware/mender-helm) for production setups.
> This docker composition is only meant for evaluation purposes.
For paying customers with access to private enterprise components, you can evaluate the Mender Server enterprise by replacing the above snippets from the following section.
To start the server run:
```
export COMPOSE_FILE="docker-compose.yml:compose/docker-compose.enterprise.yml"
docker compose up -d
```

> [!IMPORTANT]
> This composition will not work without a paid license with access to registry.mender.io.
To initialize the admin user, use the following snippet:
```
MENDER_NAME=Admin
MENDER_USERNAME=admin@mender.local
MENDER_PASSWORD=password123
docker compose exec tenantadm create-org --username "$MENDER_USERNAME" --password "$MENDER_PASSWORD" --name "$MENDER_NAME"
```

Visit [https://localhost](https://localhost) and sign in using the credentials from the snippet above.

0 comments on commit c9aa7dc

Please sign in to comment.