mirrors/kore
1
0
Fork 1
mirror of https://git.kore.io/kore.git synced 2024-11-10 20:29:11 +01:00
Code Issues Projects Releases Wiki Activity
1,189 Commits 5 Branches 46 Tags 4.4 MiB
C 98.6%
Makefile 1%
Shell 0.4%
6665ad9c45
Go to file
Joris Vink 6665ad9c45 add comment that master should always work.
2018-04-13 16:07:04 +02:00
conf Add http_request_ms configuration option. 2018-03-14 13:41:17 +01:00
examples prefix HTTP defines when exporting them to python. 2018-04-10 14:35:52 +02:00
include/kore Websocket memory leak fix when using kore_websocket_send() to send data. (#238) 2018-04-13 07:40:37 +02:00
kodev no need for -rdynamic in kodev. 2017-02-22 13:01:53 -08:00
pyko better pyko readme 2018-04-10 22:48:13 +02:00
src minor style 2018-04-13 16:05:59 +02:00
.gitignore Add kodev binary and kore.features to gitignore (#226) 2018-02-17 17:28:01 +01:00
.travis.yml Updated .travis.yml to use new container-based infrastructure. 2015-10-18 14:26:44 +02:00
LICENSE update copyright year 2017-01-18 10:27:40 +01:00
Makefile install headers correct again 2018-03-30 13:47:12 +02:00
README.md add comment that master should always work. 2018-04-13 16:07:04 +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 This documentation is severly outdated at this time.

Platforms supported

  • Linux
  • OpenBSD
  • FreeBSD
  • MacOS

Building Kore

Grab the latest release tarball or clone this repository. The master branch is considered to always be 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/