Merge branch 'master' of https://github.com/auth0/nginx-jwt

Author: ChrisWhiten

.gitignore

@@ -48,3 +48,4 @@ npm-debug.log
 # Other
 *.lua.swp
 lib/
+nginx-jwt.tar.gz

README.md

@@ -6,9 +6,11 @@
 
 - [Key Features](#key-features)
 - [Install](#install)
+- [Configuration](#configuration)
 - [Usage](#usage)
 - [API Reference](#api-reference)
 - [Tests](#tests)
+- [Packaging](#packaging)
 - [Issue Reporting](#issue-reporting)
 - [Contributors](#contributors)
 - [License](#license)
@@ -21,21 +23,12 @@
 
 ## Install
 
-It is recommended to use the latest [ngx_openresty bundle](http://openresty.org/) directly as this script (and its dependencies) depend on components that are installed by **openresty**.
+> **IMPORTANT**: **nginx-jwt** is a Lua script that is designed to run on Nginx servers that have the [HttpLuaModule](http://wiki.nginx.org/HttpLuaModule) installed. But ultimately its dependencies require components available in the [OpenResty](http://openresty.org/) distribution of Nginx. Therefore, it is recommended that you use **OpenResty** as your Nginx server, and these instructions make that assumption.
 
 Install steps:
 
-1. Build the Lua script dependencies using this command:  
-
-    ```bash
-    ./build deps
-    ```
-
-    This will create a local `lib/` directory that contains all Lua scripts that the **nginx-jwt** script depends on.
-
-    **NOTE**: This command should work on Mac OS as well as Ubuntu.
-
-1. Deploy the [`nginx-jwt.lua`](nginx-jwt.lua) script as well as the local `lib/` directory (generated in the previous step) to one directory on your Nginx server.
+1. Download the latest archive package from [releases](releases).
+1. Extract the archive and deploy its contents to a directory on your Nginx server.
 1. Specify this directory's path using ngx_lua's [lua_package_path](https://github.com/openresty/lua-nginx-module#lua_package_path) directive:  
     ```lua
     # nginx.conf:
@@ -45,6 +38,9 @@ Install steps:
         ...
     }
     ```
+
+## Configuration
+
 1. Export the `JWT_SECRET` environment variable on the Nginx host, setting it equal to your JWT secret.  Then expose it to Nginx server:  
     ```lua
     # nginx.conf:
@@ -388,6 +384,27 @@ All Node.js dependencies (npm packages) for tests are maintained in this [`packa
 
 The proxy base Docker image may need to be updated periodically, usually to just rev the version of OpenResty that its using. This can be done by modifying the image's [`Dockerfile`](hosts/proxy/Dockerfile). Any change to this file will automatically result in new image builds when the `build` script is run.
 
+## Packaging
+
+When a new version of the script needs to be released, the following should be done:
+
+> **NOTE**: These steps can only performed by GitHub users with commit access to the project.
+
+1. Increment the [Semver](http://semver.org/) version in the [`version.txt`](version.txt) file as needed.
+1. Create a new git tag with the same version value (prefiexed with `v`):
+
+  ```bash
+  git tag v$(cat version.txt)
+  ```
+
+1. Push the tag to GitHub.
+1. Create a new GitHub release in [releases](releases) that's associated with the above tag.
+1. Run the following command to create a release package archive and then upload it to the release created above:  
+
+  ```bash
+  ./build package
+  ```
+
 ## Issue Reporting
 
 If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.

build

@@ -14,13 +14,14 @@ else
 fi
 
 # ensure a supported command
-commands=(run tests deps clean)
+commands=(run tests deps clean package)
 if [[ ! ${commands[*]} =~ "$command" ]]; then
     echo -e "${cyan}Unsupported command. Try:${no_color}"
     echo -e "run [NAME]: build and run backend and the specified proxy container and report back the proxy's URL"
     echo -e "tests: run the integration tests, building and running all necessary containers"
     echo -e "deps: build only Lua script dependencies"
     echo -e "clean: stop/delete all running containers and remove all images"
+    echo -e "package: build a release package archive"
 fi
 
 if [[ "$command" == "run" ]]; then
@@ -37,6 +38,20 @@ if [[ ${commands[*]} =~ "$command" ]]; then
     ./scripts/build_deps.sh
 fi
 
+if [[ "$command" == "package" ]]; then
+    echo -e "${cyan}Building package archive for version:${no_color} $(cat version.txt)"
+    archive=nginx-jwt.tar.gz
+    if [ -f $archive ] ; then 
+    rm $archive
+    fi
+
+    tar cvf $archive ./nginx-jwt.lua
+    tar rvf $archive ./version.txt
+    cd lib/
+    tar rvf ../$archive ./
+    cd ..
+fi
+
 if [[ "$command" == "run" ]]; then
     # run backend container
     ./scripts/run_backend.sh

scripts/build_deps.sh

@@ -23,6 +23,6 @@ load_dependency () {
     fi
 }
 
-load_dependency "lib/resty/jwt.lua" "SkyLothar" "lua-resty-jwt" "b7976481061239ae2027e02be552b900bf25321c" "3fbc737d2a1defcdf372cab5f854182afbcede6e"
+load_dependency "lib/resty/jwt.lua" "SkyLothar" "lua-resty-jwt" "612dcf581b5dd2b4168bab67d017c5e23b32bf0a" "cca4f2ea1f49d7c12aecc46eb151cdf63c26294b"
 load_dependency "lib/resty/hmac.lua" "jkeys089" "lua-resty-hmac" "67bff3fd6b7ce4f898b4c3deec7a1f6050ff9fc9" "44dffa232bdf20e9cf13fb37c23df089e4ae1ee2"
 load_dependency "lib/basexx.lua" "aiq" "basexx" "514f46ceb9a8a867135856abf60aaacfd921d9b9" "da8efedf0d96a79a041eddfe45a6438ea4edf58b"

version.txt

@@ -0,0 +1 @@
+1.0.1