This is a small docker image for Landoop's schema-registry-ui. It serves the schema-registry-ui from port 8000 by default. A live version can be found at https://schema-registry-ui.demo.lenses.io

The software is stateless and the only necessary option is your Schema Registry URL.

To run it:

docker run --rm -p 8000:8000 \
           -e "SCHEMAREGISTRY_URL=http://schema.registry.url" \
           landoop/schema-registry-ui

Visit http://localhost:8000 to see the UI.

Four of the Schema Registry UI settings need to be enabled explicitly. These are:

1. Support for global compatibility level configuration support —i.e change the default compatibility level of your schema registry.
2. Support for transitive compatibility levels (Schema Registry version 3.1.1 or better).
3. Support for Schema deletion (Schema Registry version 3.3.0 or better).
4. Support for readonly mode (overwrites settings for global compatibility configuration and schema deletion)

They are handled by the ALLOW_GLOBAL, ALLOW_TRANSITIVE, ALLOW_DELETION and READONLY_MODE environment variables. E.g:

docker run --rm -p 8000:8000 \
           -e "SCHEMAREGISTRY_URL=http://schema.registry.url" \
           -e ALLOW_GLOBAL=1 \
           -e ALLOW_TRANSITIVE=1 \
           -e ALLOW_DELETION=1 \
           -e READONLY_MODE=1 \
           landoop/schema-registry-ui

docker run --rm -p 8000:8000 \
           -e "SCHEMAREGISTRY_URL=http://schema.registry.url" \
           -e READONLY_MODE=1 \
           landoop/schema-registry-ui

If you have CORS issues or want to pass through firewalls and maybe share your server, we added the PROXY option. Run the container with -e PROXY=true and Caddy server will proxy the traffic to Schema Registry:

docker run --rm -p 8000:8000 \
           -e "SCHEMAREGISTRY_URL=http://schema.registry.url" \
           -e "PROXY=true" \
           landoop/schema-registry-ui

Important: When proxying, for the SCHEMAREGISTRY_URL you have to use an IP address or a domain that can be resolved to it. You can't use localhost even if you serve Schema Registry from your localhost. The reason for this is that a docker container has its own network, so your localhost is different from the container's localhost. As an example, if you are in your home network and have an IP address of 192.168.5.65 and run Schema Registry from your computer, instead of http://127.0.0.1:8082 you must use http://192.168.5.65:8082.

If your Schema Registry uses self-signed SSL certificates, you can use the PROXY_SKIP_VERIFY=true environment variable to instruct the proxy to not verify the backend TLS certificate.

You can control most of Kafka Topics UI settings via environment variables:

• SCHEMAREGISTRY_URL
• ALLOW_GLOBAL=[true|false] (default false)
• ALLOW_TRANSITIVE=[true|false] (default false)
• ALLOW_DELETION=[true|false] (default false).
• READONLY_MODE=[true|false] (default false).

• PROXY=[true|false]

  Whether to proxy Schema Registry endpoint via the internal webserver

• PROXY_SKIP_VERIFY=[true|false]

  Whether to accept self-signed certificates when proxying Schema Registry via https

• PORT=[PORT]

  The port number to use for schema-registry-ui. The default is 8000. Usually the main reason for using this is when you run the container with --net=host, where you can't use docker's publish flag (-p HOST_PORT:8000).

• CADDY_OPTIONS=[OPTIONS]

  The webserver that powers the image is Caddy. Via this variable you can add options that will be appended to its configuration (Caddyfile). Variables than span multiple lines are supported.

  As an example, you can set Caddy to not apply timeouts via:

  -e "CADDY_OPTIONS=timeouts none"
  

  Or you can set basic authentication via:

  -e "CADDY_OPTIONS=basicauth / [USER] [PASS]"
  

• RELATIVE_PROXY_URL=[true|false]

  When proxying Schema Registry, enabling this option will set the Schema Registry endpoint in the UI as a relative URL. This can help when running Schema Registry UI under a subpath of your server (e.g http://url:8000/sr-ui instead of http://url:8000/).

If you don't wish to proxy Schema Registry's api, you should permit CORS via setting access.control.allow.methods=GET,POST,PUT,DELETE,OPTIONS and access.control.allow.origin=*.

In the latest iterations, the container will print informational messages during startup at stderr and web server logs at stdout. This way you may sent the logs (stdout) to your favorite log management solution.