First Run¶

After building OpenECPDS, you can start the services, access the interfaces, and check the containers and logs.

Starting OpenECPDS¶

From the repository root, start the application using the Compose Makefile:

make -C run/bin/ecpds up

By default, this starts the OpenECPDS master, monitor, mover, database and Hawtio services. The AI service and OpenTelemetry test Collector are behind opt-in Compose profiles and are not started unless their profiles are enabled or their services are explicitly selected. Start the Collector separately with make start-otel from the repository root when needed. See local telemetry testing.

The remaining make commands on this page run from run/bin/ecpds:

cd run/bin/ecpds

It might take a few seconds for all the services to start. Once they are up, you can access the following URLs (update them if you changed the configuration in the compose files):

The Monitoring interface is available on port 3443 and presents a login screen prior to authentication.

Checking the containers and logs¶

To verify that the containers are running:

make ps

To view the standard output (stdout) and standard error (stderr) streams generated by the containers:

make logs

To view the logs generated by OpenECPDS, browse the following directories mounted to the containers:

run/var/log/ecpds/master
run/var/log/ecpds/monitor
run/var/log/ecpds/mover

For details on the structured events written to these logs, see Event Logging.

Additional Makefile options¶

To log in to the database:

make mariadb

To log in to the master container (use the same for monitor, mover, and database):

make connect svc=master

Stopping OpenECPDS¶

To stop the application:

make down

To clean the logs and data:

make clean

Next steps¶

• Explore the Architecture Overview.
• Learn the Key Concepts.
• Try a Use Case workflow.
• Publish images with the Release guide.