Elko -- A server framework for stateful, sessionful applications in the web
Java HTML C JavaScript PHP Shell Other
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Build
Example
Run
ServerCore
Web
ZeroMQ
.gitignore
LICENSE.md
README.md
TODO.md
pom.xml

README.md

Elko

A server framework for stateful, sessionful applications in the web

Elko is a Java-based server framework for building stateful, sessionful applications in the web. It is especially suited to applications that require realtime interaction among multiple clients, such as realtime text chat or multiplayer games, or that have a strong "push" component wherein the server needs to initiate much of the interaction, such as service monitors or realtime auctions.

Much of the scalability of the web derives from the statelessness of the HTTP protocol and the consequent ease with which load may be distributed by simply replicating web servers. However, there remain a core of interesting and valuable interactive network applications that are fundamentally stateful, and trying to shoehorn these into the web paradigm can be awkward and frustrating.

Elko is an application server framework designed to address this, enabling you to quickly and easily create applications that require a live, truly bidirectional dialog between client and server.

Elko is highly scalable and very performant. We have successfully run configurations supporting upwards of 150,000 concurrently connected real-time users on a single AWS "large" server instance.

General Information

This README describes Elko release 2.0.1, dated 23-February-2016.

The authoritative source and documentation for Elko is maintained at:

https://github.com/FUDCo/Elko (i.e., here)

or

http://elkoserver.org (which currently redirects to here)

Background and theory are discussed in a series of three Habitat Chronicles blog posts:

Elko is open source software, under the MIT license. See the file LICENSE.md

What's Here

  • Build -- contains top level build files; however, you probably want the ones in ServerCore/build instead (see the Building section immediately below).

  • ServerCore -- contains the Elko server framework itself, along with its documentation.

  • Web -- contains client-side JavaScript and HTML for interacting with Elko applications from a web browser.

  • Run -- contains a variety of shell scripts for running and managing various server farm configurations, as well as the beginnings of a web-based adminstration console (written in PHP).

  • ZeroMQ -- contains a pluggable extension that lets Elko servers talk to things using the ZeroMQ distributed messaging framework.

Building

To build the Java code from the sources directly as is, you will also need the jdep utility and GNU Make.

Note that most people doing Java development these days use one of the several popular Java IDEs and/or Maven, but at the moment there's no support here for these; I'm an old time Unix/emacs guy and never had much use for such newfangled contraptions (especially Maven, yuck). However, the Java source tree is structured in the conventional way, so you should just be able to import the source tree into your favorite IDE and press the build button.

The ServerCore classes have only two external dependencies outside the normal class libraries that are part of the standard JDK. These are the MongoDB client libaries, if want support for MongoDB-based object persistence (and which you can do without in a pinch, as it is not strictly necessary for all use cases) and the Apache Commons Codec packages (to replace the now deprecated Sun base-64 encoder and decoder that Java applications relied on for so long).

More detail on building will be presented in an accompanying BUILD.md file once I get done writing it.

All the Java code works on any standard, reasonably current JVM, as it does not make use of any language features newer than generics. The various shell scripts in the Run tree do assume a Unix shell environment, but Cygwin will suffice and they are not deeply essential anyway.

Binaries

If you don't feel like building Elko yourself, a pre-built .jar file is available in the attached Release (v2.0.1).

Documentation

Detailed API and protocl documentation is sourced in the ServerCore/doc directory, but is viewable directly here. The formatting of what's there right now is a bit rough, not having entirely made the transition from its old home, but the content per se is as complete and up to date as ever. This will get prettier when I complete the migration to Jekyll.