a1batross
/
kore
forked from mirrors/kore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
1,247 Commits 5 Branches 0 Tags 4.4 MiB
C 98.6%
Makefile 1%
Shell 0.4%
Go to file
Joris Vink 93c94eb9c1 add minisign public key 2018-07-09 07:42:18 +02:00
conf filemap and fileref improvements. 2018-06-28 23:00:42 +02:00
examples remove unneeded include. 2018-05-04 15:56:56 +02:00
include/kore resolve filemap paths after workers chrooted. 2018-07-08 17:51:35 +02:00
kodev Alter where the version number comes from. 2018-06-22 14:24:42 +02:00
pyko better pyko readme 2018-04-10 22:48:13 +02:00
share/man Flesh out the new kodev manual page. 2018-04-26 19:06:55 +02:00
src redirect to /uri/ if need be. 2018-07-09 06:28:28 +02:00
.gitignore Alter where the version number comes from. 2018-06-22 14:24:42 +02:00
.travis.yml Updated .travis.yml to use new container-based infrastructure. 2015-10-18 14:26:44 +02:00
LICENSE 2018 2018-06-19 15:07:28 +02:00
Makefile Add filemaps. 2018-06-28 13:27:44 +02:00
README.md most of the existing docs are updated. 2018-06-19 12:03:10 +02:00
minisign.pub add minisign public key 2018-07-09 07:42:18 +02:00

README.md

About

Build Status

Kore (https://kore.io) is an easy to use web application platform 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.

Key Features

  • Supports SNI
  • Supports HTTP/1.1
  • Websocket support
  • Privseps by default
  • TLS enabled by default
  • Optional background tasks
  • Built-in parameter validation
  • Optional asynchronous PostgreSQL support
  • Optional support for page handlers in Python
  • 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 worker processes
  • Build your web application as a precompiled dynamic library or single binary

And loads more.

License

  • Kore is licensed under the ISC license

Documentation

Read the documentation

Platforms supported

  • Linux
  • OpenBSD
  • FreeBSD
  • MacOS

Building Kore

Clone this repository. I highly recommend using master until the 3.0.0 release is tagged as the 2.x releases are outdated. The master branch is always stable.

Requirements

  • openssl (1.0.2k+ or 1.1.0e+) (note: this requirement drops away when building with NOTLS=1 NOHTTP=1) (note: libressl should work as a replacement)

Requirements for background tasks (optional)

  • pthreads

Requirements for pgsql (optional)

  • libpq

Requirements for python (optional)

  • Python 3.6+

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)
  • PYTHON=1 (compiles in the Python support)

Note that certain build flavors cannot be mixed together and you will just be met with compilation errors.

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.

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