Skip to content

Commit fdfb26d

Browse files
chadiiichadiii
chadiii
authored and
chadiii
committed
update readme
1 parent a83eac2 commit fdfb26d

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To solve this issue, we created the Flagship nginx module for one of the most po
1414
At the web server level, this allows to determine which feature will be utilized by each visitor using Go wrapper for C, so that we can perform feature management in web sever level.
1515
As a result, the server can respond with a cached version of the proper variation using table key/value provided by nginx, allowing regular caching schemes to function normally.
1616

17-
In brief, we introduce web experimentation at the web server level with these new modules.
17+
In brief, we introduce web experimentation at the web server level with this new module.
1818
This is a new level that sits in between the front-end and the nginx web server.
1919

2020
## Usage
@@ -33,14 +33,16 @@ The idea is to store the flag combination in cache table as a key, that refer to
3333

3434
There are 3 ways to install your nginx module
3535

36-
**Warning** all these ways require to have the file libflagship.so in your system at this exact path:
36+
**Warning**
37+
38+
- All these ways require to have the file libflagship.so in your system at this exact path:
3739

3840
```
3941
/usr/local/nginx/sbin/
4042
```
4143

42-
**Warning** In this case, the `load_module` directive should be used in nginx.conf to load the module.
43-
For instance, in our case it's:
44+
- In this case, the `load_module` directive should be used in nginx.conf to load the module.
45+
For instance, in our case it's:
4446

4547
```
4648
load_module modules/ngx_http_fs_sdk_module.so;
@@ -53,13 +55,13 @@ To build the flagship module share object file you have to download the nginx so
5355
To link statically against nginx, cd to nginx source directory and execute:
5456

5557
```
56-
./configure --with-compat --add-module=/path/to/flagship-nginx-module --with-pcre
58+
./configure --with-compat --add-module=/path/to/flagship-nginx-module --with-pcre
5759
```
5860

59-
To compile as a dynamic module (nginx 1.8.0+), cd to nginx source directory and execute:
61+
To compile as a dynamic module (nginx 1.18.0+), cd to nginx source directory and execute:
6062

6163
```
62-
./configure --with-compat --add-dynamic-module=/path/to/flagship-nginx-module --with-pcre
64+
./configure --with-compat --add-dynamic-module=/path/to/flagship-nginx-module --with-pcre
6365
```
6466

6567
#### Building from docker
@@ -158,7 +160,7 @@ IsVip:true;
158160

159161
## Running the example
160162

161-
To run the example
163+
To run the example that include running nginx server that implement caching system and a simple nodejs web app run:
162164

163165
```
164166
./example/run.sh

0 commit comments

Comments
 (0)