Skip to content

Latest commit

 

History

History
96 lines (54 loc) · 3.69 KB

README.md

File metadata and controls

96 lines (54 loc) · 3.69 KB
Raw

Gateway

Gitter Build Status

About this Project

The Gateway is a network gateway created to provide a single access point for real-time web based protocol elevation 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.

A set of client APIs are provided in the following repos.

Running via public Docker Image

  1. Edit /etc/hosts file (or equivalent) to set gateway as the Docker host. Example from /etc/hosts:

    192.168.99.100 gateway

    where the IP address is that of your Docker host.

  2. Download and run the Gateway image:

    docker run --rm -p 8000:8000 -h gateway kaazing/gateway:latest

  3. Point your browser at http://gateway:8000 to see the welcome page.

See Kaazing Gateway on Docker Hub for more information, or see below to build your own Docker container locally.

Building this Project

Requirements for building the project

  • Java 8 JDK or higher

  • Apache Maven 3.2.3 or higher, with the recommended settings:

    MAVEN_OPTS="-Xms1024m -Xmx1024m -XX:MaxPermSize=1024m"

Steps for building this project

Before building the project please import the certificate form certificates/democa.crt to the Java keystore.

To do this you can use the provided scripts:

  • certificates\add-to-cacerts.bat for Windows
  • certificates/add-to-cacerts.sh for Mac/Linux

Please note that the scripts assume you have specified a JDK in your JAVA_HOME environment variable.

To build the Gateway locally, use:

mvn clean install

Building the Docker container locally

The Docker container is not built as part of the default build of this project. To build a Docker container locally, specify the docker profile:

mvn clean install -Pdocker

For more information, and to run the Docker container this builds, see the instructions in docker directory.

Running this Project

  1. cd distribution/target

  2. Unpack the appropriate distribution

    Mac/Linux: tar -xvf kaazing-gateway-community-develop-SNAPSHOT.tar.gz

    Windows: unzip kaazing-gateway-community-develop-SNAPSHOT.zip

  3. Start the Gateway

    Mac/Linux: ./kaazing-gateway-community-develop-SNAPSHOT/bin/gateway.start

    Windows: ./kaazing-gateway-community-develop-SNAPSHOT/bin/gateway.start.bat

Running a Prebuilt Project

You can also download and run this project from kaazing.org/download

Developing Client Applications

To learn how to develop client applications using the Gateway, see the documentation on kaazing.org.

See a Live Demo

To view demo client applications running against the Gateway, visit kaazing.org/demos.

Contact

The Gateway Gitter room is the easiest way to contact the developers who maintain the project.