Repository navigation
Developer Guide: Docker compose profiles
The following services are used by the main OpenRemote code base:
- proxy - Reverse SSL proxy (HAProxy) for the web services with auto SSL certificate generation (letsencrypt)
- manager - Runs the OpenRemote Manager (by default depends on postgresql and keycloak)
- postgresql - PostgreSQL DB
- keycloak - Keycloak identity provider service
Docker compose profiles (Docker Compose .yml files) are used to configure and start required services; the standard profiles are located in the profile folder of the main OpenRemote repository.
The standard profiles are:
This is the main profile which all other profiles extend; it can't be used directly.
This is a demo profile which starts all services and provides a quick start for getting a running local deployment.
Docker images must have been pulled from Docker Hub or the full stack must be built ready to build the docker images locally:
./gradlew clean installDist
This is for demo for running the full stack on a Raspberry Pi; it doesn't use the keycloak identity service but instead uses a simple identity service.
This is for doing development work on the UI (i.e. Front end apps and/or components and/or Keycloak themes).
Docker images must have been pulled from Docker Hub or the full stack must be built ready to build the docker images locally:
./gradlew clean installDist
- Manager: https://localhost
- PostgreSQL DB: jdbc:postgresql://localhost:5432/openremote
-
../ui/keycloak/themes/openremote- Maps custom openremote keycloak theme into the Keycloak service; changes to the local theme are instantly available to the keycloak service; any new themes will need to be volume mapped individually -
../deployment- Maps deployment folder into the Manager service; the mapped local path can be overridden using theDEPLOYMENT_DIRECTORYenvironment variable (.e.g. =DEPLOYMENT_DIRECTORY=../../deployment docker-compose -f openremote/profile/dev.yml)
This is for running tests or doing development work on the Manager (in an IDE) as well as the UI (i.e. Front end apps and/or components and/or Keycloak themes); starts the Keycloak and PostgreSQL services, see the [Working on the Manager] (./Developer-Guide%3A-Working-on-the-Manager) guide for running the Manager in an IDE.
- Keycloak: http://localhost:8081/auth
- PostgreSQL DB: jdbc:postgresql://localhost:5432/openremote
-
../ui/keycloak/themes/openremote- Maps custom keycloak theme into the Keycloak service; changes to the local theme are instantly available to the keycloak service
This is the same as the Full Stack Development profile but also adds the proxy service to allow development/testing of the Manager running behind the reverse proxy with HTTPS (so development environment matches final deployment configuration).
- Manager: https://localhost
- Keycloak: http://localhost:8081/auth
- PostgreSQL DB: jdbc:postgresql://localhost:5432/openremote
-
../ui/keycloak/themes/openremote- Maps custom keycloak theme into the Keycloak service; changes to the local theme are instantly available to the keycloak service
Source · Documentation · Forum · Issues · Docker Images · OpenRemote Inc.