Open AAS Ecosystem
Guide

Getting started

Setup, configuration, and the first steps after starting the stack.

1

Prerequisites

  • Docker and Docker Compose (version 2 or newer)
  • Free ports on your local machine: 80 (AAS-Suite), 4000 (sample app), 8088 (Keycloak admin console), 8090 (AAS Twin Engine)
  • An entry in your local hosts file that points aas-ecosystem.local (the default hostname, changeable via LOCAL_HOSTNAME) to 127.0.0.1 (see Configuration)
2

Setup

In the downloaded project folder, the following command is enough to start the entire stack: 

docker compose up -d

The first start takes a bit longer, since database migrations and the Keycloak realm configuration are imported automatically.

3

Configuration

All credentials and ports are controlled via the .env file in the project folder, including:

  • Postgres credentials (POSTGRES_USER, POSTGRES_PASSWORD)
  • Keycloak admin access (KEYCLOAK_ADMIN_USERNAME, KEYCLOAK_ADMIN_PASSWORD)
  • Initial organization admin account for the AAS-Suite (INITIAL_ORGANISATION_ADMIN_EMAIL, INITIAL_ORGANISATION_ADMIN_PASSWORD)
  • The application's local hostname (LOCAL_HOSTNAME, default: aas-ecosystem.local) – centrally controls all URLs (login, API, Keycloak)

For http://aas-ecosystem.local to work in your browser, that hostname needs to resolve to 127.0.0.1 locally, e.g. via an entry in your hosts file (/etc/hosts on macOS/Linux, C:\Windows\System32\drivers\etc\hosts on Windows): 

127.0.0.1 aas-ecosystem.local

The default values shipped for the local demo environment:

  • Postgres: aas_user / admin-pass
  • Keycloak admin console (:8088): admin / admin
  • Organization admin login in the AAS-Suite: admin@initial.orga / secret-pass

These credentials are for the local demo environment only and must be changed for any production or publicly reachable environment.

First steps after startup

  1. Open http://aas-ecosystem.local in your browser (or your own hostname configured via LOCAL_HOSTNAME).
  2. Sign in with the initial organization admin account.
  3. Create a Digital Product Passport template in the AAS-Suite, or open the bundled sample template.
  4. Feed product data into the AAS Twin Engine's database, e.g. via the sample app included in the stack at http://localhost:4000.
  5. Retrieve the resulting AAS via the IDTA-compliant BaSyx API, or view it directly in the AAS-Suite viewer.
← Back to "What do I get?" What's next? →