Skip to content

Commit bb9534e

Browse files
update README
1 parent ac147ef commit bb9534e

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This is an NGINX module to check for a valid JWT and proxy to an upstream server or redirect to a login page. It supports additional features such as extracting claims from the JWT and placing them on the request/response headers.
44

5+
## Breaking Changes with v2
6+
7+
The `v2` branch, which has now been merged to `master` includes breaking changes. Please see the initial v2 release for details,
8+
59
## Dependencies
610

711
This module depends on the [JWT C Library](https://github.com/benmcollins/libjwt). Transitively, that library depends on a JSON Parser called [Jansson](https://github.com/akheron/jansson) as well as the OpenSSL library.
@@ -160,19 +164,19 @@ Note the `includePath` additions above -- please update them as appropriate. Nex
160164
3. Update the `includePath` entires shown above to match the ___location you chose.
161165
4. Enter the directory where you extracted NGINX and run: `./configure --with-compat`
162166

163-
#### Cloning libjwt
167+
#### Cloning `libjwt`
164168

165169
1. Clone this repository as follows (replace `<target_dir>`): `git clone [email protected]:benmcollins/libjwt.git <target_dir>
166170
2. Enter the directory and switch to the latest tag: `git checkout $(git tag | sort -Vr | head -n 1)`
167171
3. Update the `includePath` entires shown above to match the ___location you chose.
168172

169-
#### Cloning libjansson
173+
#### Cloning `libjansson`
170174

171175
1. Clone this repository as follows (replace `<target_dir>`): `git clone [email protected]:akheron/jansson.git <target_dir>
172176
2. Enter the directory and switch to the latest tag: `git checkout $(git tag | sort -Vr | head -n 1)`
173177
3. Update the `includePath` entires shown above to match the ___location you chose.
174178

175-
#### Verifing Compliation
179+
#### Verifying Compliation
176180

177181
Once you save your changes to `.vscode/c_cpp_properties.json`, you should see that warnings and errors in the Problems panel go away, at least temprorarily. Hopfeully they don't come back, but if they do, make sure your include paths are set correctly.
178182

0 commit comments

Comments
 (0)