1
0
mirror of https://git.kore.io/kore.git synced 2024-11-16 15:06:37 +01:00
Go to file
Joris Vink 9cfcd9a4be JSON API improvements.
- Try harder to mark integers as KORE_JSON_TYPE_INTEGER, especially if
  they fit in the internal representation of one (int64_t).

- Move error codes into the JSON code itself, rather then requiring
  a kore_json data structure. This allows the JSON API to relay errors
  such as "item not found" or "type mismatch" properly when looking at items.

- When asking for a KORE_JSON_TYPE_INTEGER_U64 and a KORE_JSON_TYPE_INTEGER
  was found with the same name, check if it could be returned properly and do
  so if possible.
2021-03-30 14:19:48 +02:00
conf sync config with reality 2021-03-10 17:30:01 +01:00
examples JSON API improvements. 2021-03-30 14:19:48 +02:00
include/kore JSON API improvements. 2021-03-30 14:19:48 +02:00
kodev Also add DESTDIR in the uninstall targets in kore and kodev Makefiles. 2020-09-14 14:07:31 +02:00
misc Add my helper build scripts for building custom binaries. 2020-10-08 13:53:48 +02:00
share/man Fix a couple of typos in various places. 2020-09-08 13:01:18 +02:00
src JSON API improvements. 2021-03-30 14:19:48 +02:00
tools/kore-serve Make sure kore-serve builds. 2021-01-23 11:57:20 +01:00
.gitignore Add seccomp syscall filtering to kore. 2019-09-25 14:31:20 +02:00
BEERS update counts to reflect reality 2021-03-26 10:54:47 +01:00
LICENSE bump copyright year. 2021-01-11 23:46:08 +01:00
Makefile Let VERSION depend on OBJDIR. 2021-03-09 15:13:45 +01:00
minisign.pub add minisign public key 2018-07-09 07:42:18 +02:00
README.md Add link to new release 2021-01-25 23:33:05 +01:00

About

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
  • Reload private keys and certificates on-the-fly
  • Automatic X509 certificates via ACME (with privsep)
  • 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
  • Worker processes sandboxed on OpenBSD (pledge) and Linux (seccomp)
  • Event driven (epoll/kqueue) architecture with per CPU worker processes
  • Build your web application as a precompiled dynamic library or single binary

And lots more.

License

  • Kore is licensed under the ISC license

Documentation

Read the documentation

Performance

Read the benchmarks blog post.

Platforms supported

  • Linux
  • OpenBSD
  • FreeBSD
  • MacOS

Kore only supports x64, arm and aarch64 architectures.

Building Kore

Clone this repository or get the latest release at https://kore.io/releases/4.1.0.

Requirements

  • openssl (1.0.2, 1.1.0 or 1.1.1) (note: libressl 3.0.0+ works as a replacement)

Requirement for asynchronous curl (optional)

  • libcurl (7.64.0 or higher)

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.

  • ACME=1 (compiles in ACME support)
  • CURL=1 (compiles in asynchronous curl support)
  • TASKS=1 (compiles in task support)
  • PGSQL=1 (compiles in pgsql support)
  • DEBUG=1 (enables use of -d for debug)
  • 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.

Mailing lists

patches@kore.io - Send patches here, preferably inline.

users@kore.io - Questions regarding kore.

If you want to signup to those mailing lists send an empty email to listname+subscribe@kore.io

Other mailboxes (these are not mailing lists):

security@kore.io - Mail this email if you think you found a security problem.

sponsor@kore.io - If your company would like to sponsor part of Kore development.

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