Go to file
Joris Vink 7ac1ea379d Unbreak json_yajl example. 2016-07-06 09:23:41 +02:00
conf Massive rework of HTTP layer. 2016-01-18 11:30:22 +01:00
examples Unbreak json_yajl example. 2016-07-06 09:23:41 +02:00
includes Improve kore_strlcpy(). 2016-07-04 11:41:37 +02:00
src Improve kore_strlcpy(). 2016-07-04 11:41:37 +02:00
.gitignore Ignore DSYM on osx 2014-04-12 18:49:32 +02:00
.travis.yml Updated .travis.yml to use new container-based infrastructure. 2015-10-18 14:26:44 +02:00
LICENSE Bump copyright to 2016. 2016-01-04 12:58:51 +01:00
Makefile Separate private keys from worker processes. 2016-06-08 13:56:38 +02:00
README.md Better wording. 2016-06-08 14:25:16 +02:00

README.md

About

Build Status

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 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
  • Private keys isolated in separate process
  • 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

Upcoming release

  • Kore 2.0.0 will be released 1st of August 2016.

Old releases

Building Kore

Requirements

  • openssl (latest is always the safest bet, right?) (note: this requirement drops away when building with NOTLS=1 NOHTTP=1)

Requirements for background tasks (optional)

  • pthreads

Requirements for pgsql (optional)

  • libpq

Normal compilation and installation:

# 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 TLS)
  • NOHTTP=1 (compiles Kore without HTTP support)
  • NOOPT=1 (disable compiler optimizations)

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.

If you feel like hanging out or just chatting there is an IRC chatroom (#kore-dev@irc.freenode.org).

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