mirror of
https://github.com/jorisvink/kore
synced 2025-03-09 12:39:01 -04:00
7350131232
Before kore needed to be built with NOTLS=1 to be able to do non TLS
connections. This has been like this for years.
It is time to allow non TLS listeners without having to rebuild Kore.
This commit changes your configuration format and will break existing
applications their config.
Configurations now get listener {} contexts:
listen default {
bind 127.0.0.1 8888
}
The above will create a listener on 127.0.0.1, port 8888 that will serve
TLS (still the default).
If you want to turn off TLS on that listener, specify "tls no" in that
context.
Domains now need to be attached to a listener:
Eg:
domain * {
attach default
}
For the Python API this kills kore.bind(), and kore.bind_unix(). They are
replaced with:
kore.listen("name", ip=None, port=None, path=None, tls=True).
118 lines
3.0 KiB
Markdown
118 lines
3.0 KiB
Markdown
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
|
|
* 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](https://docs.kore.io/3.2.0/)
|
|
|
|
Performance
|
|
-----------
|
|
Read the [benchmarks](https://blog.kore.io/posts/benchmarks) blog post.
|
|
|
|
Platforms supported
|
|
-------------------
|
|
* Linux
|
|
* OpenBSD
|
|
* FreeBSD
|
|
* MacOS
|
|
|
|
Building Kore
|
|
-------------
|
|
Clone this repository or get the latest release at [https://kore.io/releases/3.2.0](https://kore.io/releases/3.2.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
|
|
|
|
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_**.
|
|
|
|
* 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/
|