kore-doc

The kore documentation found under https://docs.kore.io/
Commits | Files | Refs | README | git clone https://git.kore.io/kore-doc.git

install.md (1689B)



      1 # Installation
      2 
      3 ### Building and installing
      4 
      5 Kore has been tested to run on the following platforms:
      6 
      7 * Linux
      8 * OpenBSD
      9 * FreeBSD
     10 * macOS
     11 
     12 Get the 4.2.0 release tarball and signature from [https://kore.io/releases/4.2.0](https://kore.io/releases/4.2.0) and verify it using minisign:
     13 
     14 ```
     15 minisign -Vm kore-4.2.0.tgz -P RWSxkEDc2y+whfKTmvhqs/YaFmEwblmvar7l6RXMjnu6o9tZW3LC0Hc9
     16 ```
     17 
     18 If verification is successful, build it. Do not build distributions that
     19 cannot be verified by the minisign key seen above.
     20 
     21 ```
     22 $ cd kore
     23 $ make
     24 $ sudo make install
     25 ```
     26 
     27 Kore has several build flavors available:
     28 
     29 * ACME=1 (compiles in ACME support)
     30 * CURL=1 (compiles in asynchronous curl support)
     31 * TASKS=1 (compiles in task support)
     32 * PGSQL=1 (compiles in pgsql support)
     33 * DEBUG=1 (enables use of -d for debug)
     34 * NOHTTP=1 (compiles Kore without HTTP support)
     35 * NOOPT=1 (disable compiler optimizations)
     36 * JSONRPC=1 (compiles in JSONRPC support)
     37 * PYTHON=1 (compiles in the Python support)
     38 * TLS_BACKEND=none (compiles Kore without any TLS backend)
     39 
     40 These build flavors can be passed on the command line when building. Note that enabling these flavors may require additional libraries to be present on your system:
     41 
     42 Base requirements
     43 * openssl 1.1.1 or libressl 3.x
     44 (note: openssl 3.0.0 is currently *not* supported)
     45 
     46 Requirement for asynchronous curl (optional)
     47 * libcurl (7.64.0 or higher)
     48 
     49 Requirements for background tasks (optional)
     50 * pthreads
     51 
     52 Requirements for pgsql (optional)
     53 * libpq
     54 
     55 Requirements for python (optional)
     56 * Python 3.6+
     57 
     58 For BSD-like systems you will need to install GNU Make.
     59 
     60 ### macOS
     61 
     62 Kore is available on Homebrew under macOS and can be installed with:
     63 
     64 ```
     65 $ brew install kore
     66 `