kore-doc

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

commit 2ceb20a80543e81c69996235a92743c4ca604ce0
parent 7e78ac4c4dd8145cb7439f17a5b7ef1b784b574f
Author: Joris Vink <joris@coders.se>
Date:   Mon,  9 Jul 2018 08:58:48 +0200

move chapter + update links

Diffstat:
SUMMARY.md | 2+-
chapter1.md | 68--------------------------------------------------------------------
install.md | 67+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 68 insertions(+), 69 deletions(-)

diff --git a/SUMMARY.md b/SUMMARY.md @@ -1,7 +1,7 @@ # Summary * [Introduction](README.md) -* [Installation](chapter1.md) +* [Installation](install.md) * [Applications](applications/README.md) * [The kodev tool](applications/integrated_tools.md) * [Build framework](applications/building.md) diff --git a/chapter1.md b/chapter1.md @@ -1,68 +0,0 @@ -# Installation - -### Building and installing - -Kore has been tested to run on the following platforms: - -* Linux 3.2 or newer -* OpenBSD 5.3 or newer -* FreeBSD 10 or newer -* OSX 10.10.x or newer - -Basic compilation requires the following libraries: - -* openssl - -Download the latest release tarball from [https://github.com/jorisvink/kore/releases](https://github.com/jorisvink/kore/releases) and build it: - -``` -$ cd kore -$ make -$ sudo make install -``` - -Kore has several build flavors available: - -* TASKS=1 \(compiles in task support\) -* PGSQL=1 \(compiles in pgsql support\) -* DEBUG=1 \(enables use of -d for debug\) -* NOTLS=1 \(compiles Kore without TLS\) -* NOHTTP=1 \(compiles Kore without HTTP support\) -* NOOPT=1 \(disable compiler optimizations\) -* JSONRPC=1 \(compiles in JSONRPC support\) -* PYTHON=1 \(compiles in Python support\) - -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.: - -Requirements for background tasks \(optional\) - -* pthreads - -Requirements for pgsql \(optional\) - -* libpq - -Requirements for python \(optional\) - -* Python 3.6+ - -For BSD-like systems you will need to install GNU make. - -### OSx - -Kore is available on Homebrew under OSx and can be installed with: - -``` -$ brew install kore -``` - -### Verification - -All releases can be verified with [minisign](https://jedisct1.github.io/minisign/) and the following public key: - -``` -RWSxkEDc2y+whfKTmvhqs/YaFmEwblmvar7l6RXMjnu6o9tZW3LC0Hc9 -``` - - - diff --git a/install.md b/install.md @@ -0,0 +1,67 @@ +# Installation + +### Building and installing + +Kore has been tested to run on the following platforms: + +* Linux 3.2 or newer +* OpenBSD 5.3 or newer +* FreeBSD 10 or newer +* OSX 10.10.x or newer + +Basic compilation requires the following libraries: + +* openssl 1.0.2 or 1.1.0 / libressl + +Get the 3.0.0 release tarball and signature from [https://kore.io/releases/3.0.0](https://kore.io/releases/3.0.0) and verify it using minisign: + +``` +minisign -Vm kore-3.0.0.tgz -P RWSxkEDc2y+whfKTmvhqs/YaFmEwblmvar7l6RXMjnu6o9tZW3LC0Hc9 +``` + +If verification is successfull, build it. Do not build distributions that +cannot be verified by the minisign key seen above. + +``` +$ cd kore +$ make +$ sudo make install +``` + +Kore has several build flavors available: + +* TASKS=1 \(compiles in task support\) +* PGSQL=1 \(compiles in pgsql support\) +* DEBUG=1 \(enables use of -d for debug\) +* NOTLS=1 \(compiles Kore without TLS\) +* NOHTTP=1 \(compiles Kore without HTTP support\) +* NOOPT=1 \(disable compiler optimizations\) +* JSONRPC=1 \(compiles in JSONRPC support\) +* PYTHON=1 \(compiles in Python support\) + +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.: + +Requirements for background tasks \(optional\) + +* pthreads + +Requirements for pgsql \(optional\) + +* libpq + +Requirements for python \(optional\) + +* Python 3.6+ + +For BSD-like systems you will need to install GNU make. + +### OSx + +Kore is available on Homebrew under OSx and can be installed with: + +``` +$ brew install kore +``` + + +