X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/a7094475369a56afe1845a35cd1d20b166f00f33..c6395b9f35a4229d297aef063597bc96919a7f36:/README.md diff --git a/README.md b/README.md index 26e9bc95..a3900649 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,12 @@ signal-cli is primarily intended to be used on servers to notify admins of impor ## Installation -You can [build signal-cli](#building) yourself, or use the [provided binary files](https://github.com/AsamK/signal-cli/releases/latest), which should work on Linux, macOS and Windows. For Arch Linux there is also a [package in AUR](https://aur.archlinux.org/packages/signal-cli/) and there is a [FreeBSD port](https://www.freshports.org/net-im/signal-cli) available as well. You need to have at least JRE 11 installed, to run signal-cli. +You can [build signal-cli](#building) yourself, or use the [provided binary files](https://github.com/AsamK/signal-cli/releases/latest), which should work on Linux, macOS and Windows. For Arch Linux there is also a [package in AUR](https://aur.archlinux.org/packages/signal-cli/) and there is a [FreeBSD port](https://www.freshports.org/net-im/signal-cli) available as well. + +System requirements: +- at least Java Runtime Environment (JRE) 11 +- native libraries: libzkgroup, libsignal-client + Those are bundled for x86_64 Linux, for other systems/architectures see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal) ### Install system-wide on Linux See [latest version](https://github.com/AsamK/signal-cli/releases). @@ -83,19 +88,18 @@ dependencies. If you have a recent gradle version installed, you can replace `./ ./gradlew distTar -### Building a native binary with GraalVM +### Building a native binary with GraalVM (EXPERIMENTAL) It is possible to build a native binary with [GraalVM](https://www.graalvm.org). +This is still experimental and will not work in all situations. 1. [Install GraalVM and setup the enviroment](https://www.graalvm.org/docs/getting-started/#install-graalvm) 2. [Install prerequisites](https://www.graalvm.org/reference-manual/native-image/#prerequisites) -2. Execute Gradle: +3. Execute Gradle: - ./gradle nativeImage + ./gradlew assembleNativeImage - The binary is available at - - build/native-image/signal-cli + The binary is available at *build/native-image/signal-cli* ## Troubleshooting If you use a version of the Oracle JRE and get an InvalidKeyException you need to enable unlimited strength crypto. See https://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters for instructions.