mirrors/kore - kore - Expired Mentality Git

Go to file

Joris Vink cf94a53be7 Add user callbacks for task activity. Allows one to bind a callback to a Kore task which is called everytime activity happens on the task channel. Add an example as well on how this works. Inspired by issue #68.		2015-07-01 11:01:23 +02:00
conf	Add task_threads configuration option.	2015-06-04 10:29:22 +02:00
examples	Add user callbacks for task activity.	2015-07-01 11:01:23 +02:00
includes	Improvements to our message framework.	2015-06-23 18:17:14 +02:00
src	Do not send connection:close for websocket upgrades.	2015-06-30 16:43:21 +02:00
.gitignore	Ignore DSYM on osx	2014-04-12 18:49:32 +02:00
.travis.yml	travis	2015-05-13 09:40:52 +02:00
LICENSE	Bump copyright to 2015	2015-04-07 13:08:26 +02:00
Makefile	Add our messaging framework.	2015-06-22 21:13:32 +02:00
README.md	Call it NOTLS instead.	2015-05-25 09:42:34 -04:00

README.md

About

Kore (https://kore.io) is an easy to use web application framework for writing scalable web APIs in C. Its main goals are security, scalability and allowing rapid development and deployment of such APIs.

Because of this Kore is an ideal candidate for building robust, scalable and secure web things.

Features

Supports SNI
Supports SPDY/3.1
Supports HTTP/1.1
Websocket support
Lightweight background tasks
Built-in parameter validation
Only HTTPS connections allowed
Multiple modules can be loaded at once
Built-in asynchronous PostgreSQL support
Default sane TLS ciphersuites (PFS in all major browsers)
Load your web application as a precompiled dynamic library
Modules can be reloaded on-the-fly, even while serving content
Event driven (epoll/kqueue) architecture with per CPU core workers

License

Kore is licensed under the ISC license

Platforms supported

Linux
OpenBSD
FreeBSD
OSX

See https://kore.io/doc/#requirements for more information.

Latest release

[2015-05-21] version 1.2.3 - https://kore.io/release/kore-1.2.3-release.tgz

Old releases

[2015-04-09] version 1.2.2 - https://kore.io/release/kore-1.2.2-release.tgz
[2014-12-12] version 1.2.1 - https://kore.io/release/kore-1.2.1-release.tgz
[2014-08-25] version 1.2 - https://kore.io/release/kore-1.2-stable.tgz
[2014-03-01] version 1.1 - https://kore.io/release/kore-1.1-stable.tgz

Building Kore

Requirements

libz
openssl >= 1.0.1i

Requirements for background tasks (optional)

pthreads

Requirements for pgsql (optional)

libpq

Normal compilation and installation:

# git clone https://github.com/jorisvink/kore.git
# cd kore
# make
# make install

If you would like to build a specific flavor, you can enable those by setting a shell environment variable before running make.

TASKS=1 (compiles in task support)
PGSQL=1 (compiles in pgsql support)
DEBUG=1 (enables use of -d for debug)
NOTLS=1 (compiles Kore without OpenSSL)
KORE_PEDANTIC_MALLOC=1 (zero all allocated memory)

Example libraries

You can find example libraries under examples/.

The examples contain a README file with instructions on how to build or use them.

I apologize for unclear examples or documentation, I am working on improving those.

Bugs, contributions and more

If you run into any bugs, have suggestions or patches please contact me at joris@coders.se.

More information can be found on https://kore.io/