tls: openssl_mutex_shared - note that its code was imported in the core
[sip-router] / src / modules / tls / utils / openssl_mutex_shared / README.md
index 9f2e9c5..0be8aaa 100644 (file)
@@ -1,5 +1,10 @@
 # OpenSSL Shared Mutex #
 
+**IMPORTANT: the workaround of using this preloaded shared library is no longer
+needed starting with Kamailio v5.3.0-pre1. The code of this shared library
+has been included in the core of Kamailio and the same behaviour is now
+achieved by default.**
+
 This is a shared library required as a short term workaround for using Kamailio
 with OpenSSL (libssl) v1.1. It has to be pre-loaded before starting Kamailio.
 
@@ -34,6 +39,11 @@ For Debian packing, the location is like:
 /usr/lib/x86_64-linux-gnu/kamailio/openssl_mutex_shared/openssl_mutex_shared.so
 ```
 
+Note: there is no dependency on Kamailio source code, this shared object can
+be compiled and used ouside of Kamailio source tree. It uses only Kamailio's
+Makefile system to install in the same directory like the other shared objects
+installed by Kamailio.
+
 ## Usage ##
 
 Use LD_PRELOAD to tell the linker to preload this shared object before starting
@@ -42,7 +52,7 @@ Kamailio.
 Example, when Kamailio was installed from sources:
 
 ```
-LD_PRELOAD=/usr/local/lib64/kamailio/openssl_mutex_shared/openssl_mutex_shared.so; \
+LD_PRELOAD=/usr/local/lib64/kamailio/openssl_mutex_shared/openssl_mutex_shared.so \
   /usr/local/sbin/kamailio -f /usr/local/etc/kamailio/kamailio.cfg
 ```