README.md 6.0 KB
Supported tags and respective Dockerfile links
For more information about this image and its history, please see the relevant manifest file (library/kaazing-gateway). This image is updated via pull requests to the docker-library/official-images GitHub repo.
For detailed information about the virtual/transfer sizes and individual layers of each of the above supported tags, please see the repos/kaazing-gateway/tag-details.md file in the docker-library/repo-info GitHub repo.
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.
How to use this image
Up and Running
By default the gateway runs a WebSocket echo service similar to websocket.org.
You must give your gateway container a hostname. To do this, use the docker run -h somehostname option, along with the -e option to define an environment variable, GATEWAY_OPTS, to pass this hostname to the gateway configuration (your hostname may vary):
$ docker run --name some-kaazing-gateway -h somehostname -e GATEWAY_OPTS="-Dgateway.hostname=somehostname -Xmx512m -Djava.security.egd=file:/dev/urandom"-d -p 8000:8000 kaazing-gateway
Note: the additional GATEWAY_OPTS options, -Xmx512m -Djava.security.egd=file:/dev/urandom, are added in order to preserve these values from the original Dockerfile for the gateway. The -Xmx512m value specifies a minimum Java heap size of 512 MB, and -Djava.security.egd=file:/dev/urandom is to facilitate faster startup on VMs. See the Dockerfile link referenced above for details.
You should then be able to connect to ws://somehostname:8000 from the WebSocket echo test.
Note: all of the above 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 -h somehostname -e GATEWAY_OPTS="-Dgateway.hostname=somehostname -Xmx512m -Djava.security.egd=file:/dev/urandom" -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 For Administrators section).
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:/kaazing-gateway/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
GATEWAY_OPTS
For more information on the GATEWAY_OPTS environment variable, see Configure Kaazing Gateway Using the GATEWAY_OPTS Environment Variable.
License
View license information for the software contained in this image.
Supported Docker versions
This image is officially supported on Docker version 17.03.0-ce.
Support for older versions (down to 1.6) is provided on a best-effort basis.
Please see the Docker installation documentation for details on how to upgrade your Docker daemon.
User Feedback
Issues
If you have any problems with or questions about this image, please contact us through a GitHub issue. If the issue is related to a CVE, please check for a cve-tracker issue on the official-images repository first.
You can also reach many of the official image maintainers via the #docker-library IRC channel on Freenode.
Contributing
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
Documentation
Documentation for this image is stored in the kaazing-gateway/ directory of the docker-library/docs GitHub repo. Be sure to familiarize yourself with the repository's README.md file before attempting a pull request.