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