The UI component of the Apicurio Studio application.
100M+
To start up apicurio/apicurio-studio-ui
docker run -it apicurio/apicurio-studio-ui:latest-release
You may want to map the port(s) so you can access the app
docker run -it -p 8080:8080 -p 8443:8443 apicurio/apicurio-studio-ui:latest-release
There are some configuration options that are important when starting up this component. The following is a list of environment variables that you can set (e.g. when starting the docker image):
| Env Variable Name | Description | Default Value |
|---|---|---|
| APICURIO_KC_AUTH_URL | The URL to the Keycloak authentication server. | https://studio-auth.apicur.io/auth/ |
| APICURIO_KC_REALM | The name of the Keycloak realm to use for authentication. | apicurio |
| APICURIO_KC_CLIENT_ID | The Client ID of the Keycloak client to use for authentication. | apicurio-studio |
| APICURIO_KC_SSL_REQUIRED | Used to determine whether the Keycloak server MUST be accessed via HTTPS. | NONE |
| APICURIO_KC_DISABLE_TRUST_MANAGER | Set to true to disable the HTTP client trust manager when accessing Keycloak (used when making HTTPS client calls to Keycloak). | true |
| APICURIO_PORT_OFFSET | Port offset to use when starting the server (e.g. set to 10 to shift the http port from 8080 to 8090). | 0 |
| APICURIO_LOGGING_LEVEL | Default logging level. | INFO |
| APICURIO_MIN_HEAP | Minimum java heap setting. | 768m |
| APICURIO_MAX_HEAP | Maxiumum java heap setting. | 2048m |
| APICURIO_UI_HUB_API_URL | URL to the Apicurio Studio API component (apicurio-studio-api). | https://localhost:8443/api |
| APICURIO_UI_EDITING_URL | URL to the Apicurio Studio editing component (apicurio-studio-ws). | https://localhost:8443/ws |
Note: you will typically need to at least provide the URLs to Keycloak and the Apicurio API and WS components. So a realistic startup command might look like this:
docker run -it -p 8080:8080 -p 8443:8443 \
-e "APICURIO_KC_AUTH_URL=https://keycloak.example.com/auth/" \
-e "APICURIO_UI_HUB_API_URL=https://apicurio-api.example.com/" \
-e "APICURIO_UI_EDITING_URL=https://apicurio-ws.example.com/" \
apicurio/apicurio-studio-ui:latest-release
The apicurio/apicurio-studio-ui component is only one of several components that make up the Apicurio Studio application. For Apicurio Studio to fully function, the following components are required:
| Component | Description | Docker Image |
|---|---|---|
| API | The REST API based backend. Used by the UI for most operations. | apicurio/apicurio-studio-api |
| Editing | The Web Socket based concurrent editing layer. Used by the UI only when editing an API. | apicurio/apicurio-studio-ws |
| UI | The Angular based UI. Users go here to access the Apicurio UI. | apicurio/apicurio-studio-ui |
| Auth | Keycloak server to provide authentication and account linking functionality. | apicurio/apicurio-studio-auth |
Note: you can install/run/configure your own Keycloak server if you already have one or don't want to use the apicurio/apicurio-studio-auth image.
Content type
Image
Digest
sha256:1f19c333b…
Size
215.1 MB
Last updated
10 months ago
docker pull apicurio/apicurio-studio-ui:latest-snapshot