mirrors
/
kore
mirror of https://git.kore.io/kore.git
1
0
Fork 1
Code Issues Projects Releases Wiki Activity
940 Commits 5 Branches 45 Tags 4.4 MiB
C 98.6%
Makefile 1%
Shell 0.4%
Go to file
Joris Vink 8b723479ec bump 2016-08-01 15:01:19 +02:00
conf Massive rework of HTTP layer. 2016-01-18 11:30:22 +01:00
examples JSONRPC Reverted explicit deallocation calls 2016-07-15 13:08:08 +02:00
includes bump 2016-08-01 15:01:19 +02:00
src align pointers from kore_malloc() properly. 2016-07-28 14:52:15 +02:00
.gitignore Ignored .lvimrc and prior vim stale files if there 2016-07-09 12:27:01 +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 JSONRPC requires HTTP, let users figure that out the hard way. 2016-08-01 09:25:56 +02:00
README.md Remove links to kore.io for releases 2016-08-01 09:59:32 +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
  • Privseps by default
  • Lightweight background tasks
  • Built-in parameter validation
  • Only HTTPS connections allowed
  • Built-in asynchronous PostgreSQL support
  • Private keys isolated in separate process (RSA and ECDSA)
  • Default sane TLS ciphersuites (PFS in all major browsers)
  • Modules can be reloaded on-the-fly, even while serving content
  • Event driven (epoll/kqueue) architecture with per CPU core workers
  • Build your web application as a precompiled dynamic library or single binary

License

  • Kore is licensed under the ISC license

Platforms supported

  • Linux
  • OpenBSD
  • FreeBSD
  • OSX

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

Building Kore

Requirements

  • openssl (latest) (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)
  • JSONRPC=1 (compiles in JSONRPC support)

Example applications

You can find example applications under examples/.

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

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/