https://github.com/kaazing/gateway
Kaazing Gateway
https://github.com/kaazing/gateway
Last synced: 8 months ago
JSON representation
Kaazing Gateway
- Host: GitHub
- URL: https://github.com/kaazing/gateway
- Owner: kaazing
- License: apache-2.0
- Created: 2014-11-17T07:40:57.000Z (about 11 years ago)
- Default Branch: develop
- Last Pushed: 2022-04-24T11:16:34.000Z (over 3 years ago)
- Last Synced: 2025-04-12T04:49:19.587Z (9 months ago)
- Language: Java
- Homepage:
- Size: 19.7 MB
- Stars: 141
- Watchers: 59
- Forks: 84
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: security/pom.xml
Awesome Lists containing this project
- awesome-java - Kaazing Gateway
README
# Gateway
[](https://gitter.im/kaazing/gateway?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status][build-status-image]][build-status]
[build-status-image]: https://travis-ci.org/kaazing/gateway.svg?branch=develop
[build-status]: https://travis-ci.org/kaazing/gateway
# 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.
- [JavaScript SDK for WebSocket](https://github.com/kaazing/kaazing-client-javascript)
- [Objective-C SDK for WebSocket](https://github.com/kaazing/gateway.client.ios)
- [Android and Java SDK for WebSocket](https://github.com/kaazing/gateway.client.java)
- [JavaScript SDK for AMQP 0-9-1](https://github.com/kaazing/kaazing-amqp-0-9-1-client-javascript)
- [Java SDK for AMQP 0-9-1](https://github.com/kaazing/amqp.client.java)
# Running via public Docker Image
0. 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.
0. Download and run the Gateway image:
`docker run --rm -p 8000:8000 -h gateway kaazing/gateway:latest`
0. Point your browser at `http://gateway:8000` to see the welcome page.
See Kaazing Gateway on [Docker Hub](https://registry.hub.docker.com/u/kaazing/gateway/) 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](docker).
# Running this Project
0. `cd distribution/target`
1. Unpack the appropriate distribution
Mac/Linux: `tar -xvf kaazing-gateway-community-develop-SNAPSHOT.tar.gz`
Windows: `unzip kaazing-gateway-community-develop-SNAPSHOT.zip`
2. 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](http://kaazing.org/download/)
# Developing Client Applications
To learn how to develop client applications using the Gateway, see the documentation on [kaazing.org](http://kaazing.org).
# See a Live Demo
To view demo client applications running against the Gateway, visit [kaazing.org/demos](http://kaazing.org/demos/).
# Contact
The [Gateway Gitter room](https://gitter.im/kaazing/gateway) is the easiest way to contact the developers who maintain the project.