From f7a1b097726672dd40ed7df17551229c5cf6ce7f Mon Sep 17 00:00:00 2001 From: Alf-Rune Siqveland Date: Wed, 13 Nov 2024 16:31:10 +0100 Subject: [PATCH] docs: Update README.md Adjusted styling (note color, added 1st level indentation, taxonomy i.e., Mender Server, Mender Enterprise) to make it easy to follow and read. Co-authored-by: chiachenglu <82047138+chiachenglu@users.noreply.github.com> Signed-off-by: Alf-Rune Siqveland --- README.md | 80 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 42 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index dfc4f516..c8d7a878 100644 --- a/README.md +++ b/README.md @@ -4,71 +4,75 @@ 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.23.1` or newer. - -```bash -docker compose version -``` - -You will also need to update your local DNS or host rewrites, for example by appending to `/etc/hosts`: - -```bash -echo '127.0.0.1 docker.mender.io s3.docker.mender.io' | sudo tee -a /etc/hosts -``` +This tutorial teaches you how to setup up the Mender Server for evaluation purposes. +The tutorial will take you through starting the Mender Server and adding a virtual device to learn how Mender works. > [!NOTE] > This docker composition is only meant for evaluation purposes. > Please use [the helm chart](https://github.com/mendersoftware/mender-helm) in production environments. -Start by cloning and entering this repository: +### Prerequisites -```bash -git clone https://github.com/mendersoftware/mender-server && cd mender-server -``` +* 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.23.1` or newer. -To start evaluating Mender, you can bring up your Mender server by running: + ```bash + docker compose version + ``` -```bash -docker compose up -d -``` +* You will also need to update your local DNS or host rewrites, for example by appending to `/etc/hosts`: -Once all containers are running, you can create your initial user using the following command: + ```bash + echo '127.0.0.1 docker.mender.io s3.docker.mender.io' | sudo tee -a /etc/hosts + ``` -```bash -MENDER_USERNAME=admin@docker.mender.io -MENDER_PASSWORD=password123 -docker compose exec useradm useradm create-user --username "$MENDER_USERNAME" --password "$MENDER_PASSWORD" -``` +### Starting the Mender Server -Visit [https://localhost](https://localhost) and sign in using the credentials from the snippet above. +1. Start by cloning and entering this repository: -### Adding a virtual client + ```bash + git clone https://github.com/mendersoftware/mender-server && cd mender-server + ``` -To add a virtual client with the composition, run the following command: +2. To start evaluating Mender, you can bring up your Mender Server by running: -```bash -docker compose run -d client -``` + ```bash + docker compose up -d + ``` -### Evaluating Mender enterprise +3. Once all containers are running, you can create your initial user using the following command: + + ```bash + MENDER_USERNAME=admin@docker.mender.io + MENDER_PASSWORD=password123 + docker compose exec useradm useradm create-user --username "$MENDER_USERNAME" --password "$MENDER_PASSWORD" + ``` + +4. Visit [https://docker.mender.io](https://docker.mender.io) and sign in using the credentials from the snippet above. + +5. To add a virtual client with the composition, run the following command: + + ```bash + docker compose run -d client + ``` + +## 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: +For paying customers with access to Mender Enterprise components, you can evaluate the Mender Server Enterprise by replacing the snippet in step 2 above to: ```bash export COMPOSE_FILE="docker-compose.yml:compose/docker-compose.enterprise.yml" docker compose up -d ``` -> [!IMPORTANT] +> [!NOTE] > This composition will not work without a paid license with access to registry.mender.io. -To initialize the admin user, use the following snippet: +To initialize the admin user, use the following snippet in step 3: ```bash MENDER_NAME=Admin @@ -79,7 +83,7 @@ docker compose exec tenantadm tenantadm create-org --username "$MENDER_USERNAME" Visit [https://localhost](https://localhost) and sign in using the credentials from the snippet above. -### Testing Gitlab build artifacts +## Testing Gitlab build artifacts To test/debug artifacts from GitLab CI, you can pull the image straight from the internal registry (after generating credentials). For testing, you need to setup the following environment variables: