README.md (3406B)
1 About
2 -----
3
4 Kore (https://kore.io) is an easy to use web application platform for
5 writing scalable web APIs in C. Its main goals are security, scalability
6 and allowing rapid development and deployment of such APIs.
7
8 Because of this Kore is an ideal candidate for building robust, scalable and secure web things.
9
10 Key Features
11 ------------
12 * Supports SNI
13 * Supports HTTP/1.1
14 * Websocket support
15 * Privseps by default
16 * TLS enabled by default
17 * Optional background tasks
18 * Built-in parameter validation
19 * Optional asynchronous PostgreSQL support
20 * Optional support for page handlers in Python
21 * Reload private keys and certificates on-the-fly
22 * Automatic X509 certificates via ACME (with privsep)
23 * Private keys isolated in separate process (RSA and ECDSA)
24 * Default sane TLS ciphersuites (PFS in all major browsers)
25 * Modules can be reloaded on-the-fly, even while serving content
26 * Worker processes sandboxed on OpenBSD (pledge) and Linux (seccomp)
27 * Event driven (epoll/kqueue) architecture with per CPU worker processes
28 * Build your web application as a precompiled dynamic library or single binary
29
30 And lots more.
31
32 License
33 -------
34 * Kore is licensed under the ISC license
35
36 Documentation
37 --------------
38 [Read the documentation](https://docs.kore.io/4.2.0/)
39
40 Performance
41 -----------
42 Read the [benchmarks](https://blog.kore.io/posts/benchmarks) blog post.
43
44 Platforms supported
45 -------------------
46 * Linux
47 * OpenBSD
48 * FreeBSD
49 * MacOS
50
51 Kore only supports x64, arm and aarch64 architectures.
52
53 Building Kore
54 -------------
55 Clone this repository or get the latest release at [https://kore.io/releases/4.2.2](https://kore.io/releases/4.2.2).
56
57 Requirements
58 * openssl 1.1.1 or libressl 3.x
59 (note: openssl 3.0.0 is currently *not* supported)
60
61 Requirement for asynchronous curl (optional)
62 * libcurl (7.64.0 or higher)
63
64 Requirements for background tasks (optional)
65 * pthreads
66
67 Requirements for pgsql (optional)
68 * libpq
69
70 Requirements for python (optional)
71 * Python 3.6+
72
73 Normal compilation and installation:
74
75 ```
76 $ cd kore
77 $ make
78 # make install
79 ```
80
81 If you would like to build a specific flavor, you can enable
82 those by setting a shell environment variable before running **_make_**.
83
84 * ACME=1 (compiles in ACME support)
85 * CURL=1 (compiles in asynchronous curl support)
86 * TASKS=1 (compiles in task support)
87 * PGSQL=1 (compiles in pgsql support)
88 * DEBUG=1 (enables use of -d for debug)
89 * NOHTTP=1 (compiles Kore without HTTP support)
90 * NOOPT=1 (disable compiler optimizations)
91 * JSONRPC=1 (compiles in JSONRPC support)
92 * PYTHON=1 (compiles in the Python support)
93 * TLS_BACKEND=none (compiles Kore without any TLS backend)
94
95 Note that certain build flavors cannot be mixed together and you will just
96 be met with compilation errors.
97
98 Example applications
99 -----------------
100 You can find example applications under **_examples/_**.
101
102 The examples contain a README file with instructions on how
103 to build or use them.
104
105 Mailing lists
106 -------------
107
108 **patches@kore.io** - Send patches here, preferably inline.
109
110 **users@kore.io** - Questions regarding kore.
111
112
113 If you want to signup to those mailing lists send an empty email to
114 listname+subscribe@kore.io
115
116
117 Other mailboxes (these are **not** mailing lists):
118
119 **security@kore.io** - Mail this email if you think you found a security problem.
120
121 **sponsor@kore.io** - If your company would like to sponsor part of Kore development.
122
123 More information can be found on https://kore.io/