content.md 2.0 KB

What is the KAAZING Gateway?

The Kaazing Gateway is a network gateway created to provide a single access point for real-time web based protocols that supports load balancing, clustering, and security management. It is designed to provide scalable and secure bidirectional event-based communication over the web; on every platform, browser, and device.

%%LOGO%%

How to use this image

Up and Running

By default the gateway runs a WebSocket echo service similar to websocket.org.

$ docker run --name some-kaazing-gateway -h somehostname -d -p 8000:8000 kaazing-gateway

You should then be able to connect to ws://somehostname:8000 from the WebSocket echo test.

Note: this assumes that somehostname is resolvable from your browser, you may need to add an etc/hosts entry for somehostname on your dockerhost ip.

Custom Configuration

To launch a container with a specific configuration you can do the following:

$ docker run --name some-kaazing-gateway -v /some/gateway-config.xml:/kaazing-gateway/conf/gateway-config.xml:ro -d kaazing-gateway

For information on the syntax of the Kaazing Gateway configuration files, see the official documentation (specifically the Configuration Guide).

If you wish to adapt the default Gateway configuration file, you can use a command such as the following to copy the file from a running Kaazing Gateway container:

$ docker cp some-kaazing:/conf/gateway-config-minimal.xml /some/gateway-config.xml

As above, this can also be accomplished more cleanly using a simple Dockerfile:

FROM kaazing-gateway
COPY gateway-config.xml /conf/gateway-config.xml

Then, build with docker build -t some-custom-kaazing-gateway . and run:

$ docker run --name some-kaazing-gateway -d some-custom-kaazing-gateway