From ed9a45fb7ced6445dd779c529052f6fc1b1a40ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jiri=20Dan=C4=9Bk?= Date: Sun, 26 Mar 2023 14:32:20 +0200 Subject: [PATCH] Document project requirements, esp. tcnative openssl integration --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c318c26b..0117a62b 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,14 @@ cli-java is a collection of commandline messaging clients suitable for interacting with Message Oriented Middleware. +## Requirements + +* Java 11+ +* Maven 3 +* for [tcnative](https://netty.io/wiki/forked-tomcat-native.html) dynamic library, [outdated openssl 1.0 is required](https://github.com/netty/netty-tcnative/issues/551) + * on Fedora 37, execute `sudo dnf install -y apr https://kojipkgs.fedoraproject.org//packages/compat-openssl10/1.0.2o/11.fc33/x86_64/compat-openssl10-1.0.2o-11.fc33.x86_64.rpm` + * or, enable use of [BoringSSL](https://github.com/google/boringssl) static library instead of the dynamic one, with `-P tcnative-boringssl-static` profile to maven + ## Getting started mvn clean package # compile without executing external tests (tests that require broker)