X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/4f9c0172ef42b03e34d7756b96cbb6f522c68adf..17d00d6ca8d10ffb783707b12181b29c8fb8a97a:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 5eb9e78d..86e8591b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ 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) + Those are bundled for x86_64 Linux (with recent enough glibc, see #643), 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). @@ -36,8 +36,10 @@ Important: The USERNAME is your phone number in international format and must in * Register a number (with SMS verification) signal-cli -u USERNAME register - - You can register Signal using a land line number. In this case you can skip SMS verification process and jump directly to the voice call verification by adding the --voice switch at the end of above register command. + + You can register Signal using a land line number. In this case you can skip SMS verification process and jump directly to the voice call verification by adding the `--voice` switch at the end of above register command. + + Registering may require solving a CAPTCHA challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha) * Verify the number using the code received via SMS or voice, optionally add `--pin PIN_CODE` if you've added a pin code to your account @@ -50,22 +52,24 @@ Important: The USERNAME is your phone number in international format and must in * Pipe the message content from another process. uname -a | signal-cli -u USERNAME send RECIPIENT - + * Receive messages signal-cli -u USERNAME receive +**Hint**: The Signal protocol expects that incoming messages are regularly received (using `daemon` or `receive` command). +This is required for the encryption to work efficiently and for getting updates to groups, expiration timer and other features. ## Storage The password and cryptographic keys are created when registering and stored in the current users home directory: -`$XDG_DATA_HOME/signal-cli/data/` (`$HOME/.local/share/signal-cli/data/`) + $XDG_DATA_HOME/signal-cli/data/ + $HOME/.local/share/signal-cli/data/ For legacy users, the old config directories are used as a fallback: $HOME/.config/signal/data/ - $HOME/.config/textsecure/data/ ## Building @@ -99,11 +103,11 @@ This is still experimental and will not work in all situations. 3. Execute Gradle: ./gradlew assembleNativeImage - + 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. +## FAQ and Troubleshooting +For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ) ## License