Skip to content

Commit 27c2e3d

Browse files
committed
Update installation instructions.
1 parent 2a0ce5d commit 27c2e3d

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,25 @@ Executing commands via MQ services:
3636

3737
## installation
3838

39-
`punch-q` can be installed via `pip` with `pip install punch-q`.
39+
This utility relies on [pymqi](https://github.com/dsuch/pymqi) and needs to be successfully installed for `punch-q` to work. The installation of `pymqi` relies on the IBM MQ client utilities to be installed which you would need to download from IBM's website first. [This](https://github.com/dsuch/pymqi/issues/15#issuecomment-124772995) Github issue can be used as a reference to install the correct MQ Client libraries.
40+
41+
In summary, to get the IBM MQ client for `pymqi` and `punch-q` working, you need to:
42+
43+
- Download the IBM MQ Client libraries from IBM's [website](http://www-01.ibm.com/software/integration/wmq/clients/). The version 7.5 x64 Linux client library was used while testing `punch-q` and can be found [here](https://www-945.ibm.com/support/fixcentral/swg/downloadFixes?parent=ibm~WebSphere&product=ibm/WebSphere/WebSphere+MQ&release=7.5.0.8&platform=All&function=fixId&fixids=7.5.0.8-WS-MQC-LinuxX64&useReleaseAsTarget=true&includeRequisites=0&includeSupersedes=0&downloadMethod=http) (You may need to login with an IBM ID first).
44+
- After the download is complete, extract the archives contents and accept the IBM license agreement with `/mqlicense.sh -accept`.
45+
- Install the `MQSeriesRuntime`, `MQSeriesClient` and `MQSeriesSDK` RPM's. These can be installed on Kali Linux after installing `rpm` with `rpm -ivh <PackageName>.rpm`.
46+
47+
Finally, with the MQ series client installed, `punch-q` itself can be installed with:
48+
49+
```bash
50+
pip install punch-q
51+
```
52+
53+
*Note:* When running `punch-q`, and you get an error similar to `ImportError: libmqic_r.so: cannot open shared object file: No such file or directory`, simply set the `LB_LIBRARY_PATH` to /opt/mqm/lib64 library with:
54+
55+
```bash
56+
export LD_LIBRARY_PATH=/opt/mqm/lib64
57+
```
4058

4159
## license
4260

0 commit comments

Comments
 (0)