Skip to content

Commit

Permalink
QATAPP-20834: Update README for v0.4.5 release
Browse files Browse the repository at this point in the history
Update software package dependancy.
Update `Additional Information` section, so that user can use both
hg and git repo to format a patch to use.
Fix markdown grammar error

Signed-off-by: David Qian <[email protected]>
  • Loading branch information
zhangp8x authored and daweiq committed Mar 19, 2021
1 parent c8adc37 commit 7f674ff
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ This release was validated on the following:
Please download the QAT driver from the link https://01.org/intel-quickassist-technology
* OpenSSL-1.1.1i
* QAT engine v0.6.4
* QATzip v1.0.2
* QATzip v1.0.3

## Additional Information

Expand All @@ -87,15 +87,32 @@ Please download the QAT driver from the link https://01.org/intel-quickassist-te
```bash
git clone https://github.com/intel/asynch_mode_nginx.git
wget http://nginx.org/download/nginx-1.18.0.tar.gz
tar -xvzf ./nginx-1.18.0.tar.gz
tar -xvzf nginx-1.18.0.tar.gz
diff -Naru -x .git nginx-1.18.0 asynch_mode_nginx > async_mode_nginx_1.18.0.patch
```

* Apply patch to official Nginx-1.18.0.

```bash
wget http://nginx.org/download/nginx-1.18.0.tar.gz
tar -xvzf ./nginx-1.18.0.tar.gz
tar -xvzf nginx-1.18.0.tar.gz
patch -p0 < async_mode_nginx_1.18.0.patch
```

* Generate patch against github official read-only mirror

```bash
git clone https://github.com/intel/asynch_mode_nginx.git
wget https://github.com/nginx/nginx/archive/release-1.18.0.tar.gz
tar -xvzf release-1.18.0.tar.gz
diff -Naru -x .git -x .hgtags nginx-release-1.18.0 asynch_mode_nginx > async_mode_nginx_1.18.0.patch
```

* Apply patch to the github release pachage.

```bash
wget https://github.com/nginx/nginx/archive/release-1.18.0.tar.gz
tar -xvzf release-1.18.0.tar.gz
patch -p0 < async_mode_nginx_1.18.0.patch
```

Expand Down Expand Up @@ -282,7 +299,7 @@ is configured as
--with-http_ssl_module \
--add-dynamic-module=modules/nginx_qatzip_module \
--add-dynamic-module=modules/nginx_qat_module/ \
--with-cc-opt="-DNGX_SECURE_MEM -I$OPENSSL_LIB/include -I$QZ_ROOT/include -Wno-error=deprecated-declarations" \
--with-cc-opt="-DNGX_SECURE_MEM -I$OPENSSL_LIB/include -I$ICP_ROOT/quickassist/include -I$ICP_ROOT/quickassist/include/dc -I$QZ_ROOT/include -Wno-error=deprecated-declarations" \
--with-ld-opt="-Wl,-rpath=$OPENSSL_LIB/lib -L$OPENSSL_LIB/lib -L$QZ_ROOT/src -lqatzip -lz"
```

Expand All @@ -293,7 +310,7 @@ is configured as
make install
```

** Nginx supports setting worker to non-root user, for example:**
**Nginx supports setting worker to non-root user, for example:**

Add user qat in group qat, for example run below command in your terminal:
```bash
Expand Down

0 comments on commit 7f674ff

Please sign in to comment.