diff --git a/README.md b/README.md index 099bd7d..32827e6 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,27 @@ This is an NGINX module to check for a valid JWT, this module intend to be as li - Docker image based on the [official nginx Dockerfile](https://github.com/nginxinc/docker-nginx) (alpine). - Light image (~400KB more than the official one). +### Pre-built Packages (Ubuntu / Debian) + +Pre-built packages for this module are freely available from the GetPageSpeed repository: + +```bash +# Install the repository keyring +sudo install -d -m 0755 /etc/apt/keyrings +curl -fsSL https://extras.getpagespeed.com/deb-archive-keyring.gpg \ + | sudo tee /etc/apt/keyrings/getpagespeed.gpg >/dev/null + +# Add the repository (Ubuntu example - replace 'ubuntu' and 'jammy' for your distro) +echo "deb [signed-by=/etc/apt/keyrings/getpagespeed.gpg] https://extras.getpagespeed.com/ubuntu jammy main" \ + | sudo tee /etc/apt/sources.list.d/getpagespeed-extras.list + +# Install nginx and the module +sudo apt-get update +sudo apt-get install nginx nginx-module-jwt +``` + +The module is automatically enabled after installation. Supported distributions include Debian 12/13 and Ubuntu 20.04/22.04/24.04 (both amd64 and arm64). See [the complete setup instructions](https://apt-nginx-extras.getpagespeed.com/apt-setup/). + ### Table of Contents: - [Module configuration](#module-configuration) @@ -58,7 +79,7 @@ http { } ``` -Note: don't forget to [load](http://nginx.org/en/docs/ngx_core_module.html#load_module) the module in the main context: +Note: don't forget to [load](http://nginx.org/en/docs/ngx_core_module.html#load_module) the module in the main context: ```nginx load_module /usr/lib/nginx/modules/ngx_http_auth_jwt_module.so; ```