Skip to content

Commit b089bcb

Browse files
authored
CPP-881 - Add missing documentation for zlib dependency (#10)
1 parent 6d997ae commit b089bcb

File tree

4 files changed

+49
-10
lines changed

4 files changed

+49
-10
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ Binary versions of the driver, available for multiple operating systems and
1414
multiple architectures, can be obtained from our [download server]. The
1515
source code is made available via [GitHub].
1616

17-
Packages for the driver's dependencies, libuv (1.x)
18-
and OpenSSL, are also provided under the `dependencies` directory for each
19-
platform (if applicable). __Note__: CentOS and Ubuntu use the version of OpenSSL
20-
provided with the distribution:
17+
Packages for the driver's dependencies, libuv (1.x), OpenSSL, and zlib are also
18+
provided under the `dependencies` directory for each platform (if applicable).
19+
__Note__: CentOS and Ubuntu use the version of OpenSSL and zlib provided with the
20+
distribution:
2121

2222
* [CentOS 6][centos-6-dependencies]
2323
* [CentOS 7][centos-7-dependencies]

topics/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Packages are available for the following platforms:
1515

1616
### Dependencies
1717

18-
Packages for the dependencies, libuv (1.x) and OpenSSL are also provided and
19-
can be found under the "dependencies" directory for each platform:
18+
Packages for the dependencies, libuv (1.x), OpenSSL, and zlib are also provided
19+
and can be found under the "dependencies" directory for each platform:
2020

2121
* [CentOS 6][cpp-driver-dependencies-centos6]
2222
* [CentOS 7][cpp-driver-dependencies-centos7]
@@ -25,7 +25,7 @@ can be found under the "dependencies" directory for each platform:
2525
* [Ubuntu 18.04 LTS][cpp-driver-dependencies-ubuntu18-04]
2626
* [Windows][cpp-driver-dependencies-windows]
2727

28-
*Note*: CentOS and Ubuntu use the version of OpenSSL provided with the
28+
*Note*: CentOS and Ubuntu use the version of OpenSSL and zlib provided with the
2929
distribution.
3030

3131
The driver can also be [built from source].

topics/building/README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,20 @@ The C/C++ driver depends on the following software:
2828
* [libuv] 1.x
2929
* Kerberos v5 ([Heimdal] or [MIT]) \*
3030
* [OpenSSL] v1.0.x or v1.1.x \*\*
31+
* [zlib] v1.x \*\*\*
3132

3233
__\*__ Use the `CASS_USE_KERBEROS` CMake option to enable/disable Kerberos
3334
support. Enabling this option will enable Kerberos authentication
3435
protocol within the driver; defaults to `Off`.
36+
3537
__\*\*__ Use the `CASS_USE_OPENSSL` CMake option to enable/disable OpenSSL
3638
support. Disabling this option will disable SSL/TLS protocol support
3739
within the driver; defaults to `On`.
3840

41+
__\*\*\*__ Use the `CASS_USE_ZLIB` CMake option to enable/disable zlib support.
42+
Disabling this option will disable DataStax Constellation support
43+
within the driver; defaults to `On`.
44+
3945
## Linux/Mac OS
4046

4147
The driver is known to build on CentOS/RHEL 6/7, Mac OS X 10.10/10.11 (Yosemite
@@ -163,7 +169,39 @@ wget --no-check-certificate https://www.openssl.org/source/openssl-1.0.2s.tar.gz
163169
tar xzf openssl-1.0.2s.tar.gz
164170
pushd openssl-1.0.2s
165171
CFLAGS=-fpic ./config shared
166-
make
172+
make install
173+
popd
174+
popd
175+
```
176+
177+
#### zlib
178+
179+
##### CentOS (Yum)
180+
181+
```bash
182+
yum install zlib-devel
183+
```
184+
185+
##### Ubuntu (APT)
186+
187+
```bash
188+
apt-get install zlib1g-dev
189+
```
190+
191+
##### Mac OS (Brew)
192+
193+
```bash
194+
brew install zlib
195+
```
196+
197+
##### Manually build and install
198+
199+
```bash
200+
pushd /tmp
201+
wget --no-check-certificate https://www.zlib.net/zlib-1.2.11.tar.gz
202+
tar xzf zlib-1.2.11.tar.gz
203+
pushd zlib-1.2.11
204+
./configure
167205
make install
168206
popd
169207
popd
@@ -312,3 +350,4 @@ cmake -G "Visual Studio 16 2019" -A x64 -DCASS_BUILD_UNIT_TESTS=On ..
312350
[Heimdal]: https://www.h5l.org
313351
[MIT]: https://web.mit.edu/kerberos
314352
[OpenSSL]: https://www.openssl.org
353+
[zlib]: https://www.zlib.net

topics/installation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ CentOS doesn't have up-to-date versions of libuv so we provide current packages.
5656
Install dependencies:
5757

5858
```bash
59-
yum install openssl krb5
59+
yum install openssl krb5 zlib
6060
rpm -Uvh libuv-<version>.rpm
6161
```
6262

@@ -135,7 +135,7 @@ Ubuntu doesn't have up-to-date versions of libuv so we provide current packages.
135135
Install dependencies:
136136

137137
```bash
138-
apt-get install libssl libkrb5
138+
apt-get install libssl libkrb5 zlib1g
139139
dpkg -i libuv_<version>.deb
140140
```
141141

0 commit comments

Comments
 (0)