Skip to content

Commit 60893da

Browse files
authored
docs: add pre-built Ubuntu/Debian package installation instructions (#21)
1 parent dc641de commit 60893da

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,40 @@ Nginx HMAC Secure Link Module
44
Description:
55
============
66

7-
The Nginx HMAC secure link module enhances the security and functionality of the standard secure link module.
7+
The Nginx HMAC secure link module enhances the security and functionality of the standard secure link module.
88
Secure token is created using secure HMAC construction with an arbitrary hash algorithm supported by OpenSSL, e.g.:
99
`blake2b512`, `blake2s256`, `gost`, `md4`, `md5`, `mdc2`, `rmd160`, `sha1`, `sha224`, `sha256`,
1010
`sha3-224`, `sha3-256`, `sha3-384`, `sha3-512`, `sha384`, `sha512`, `sha512-224`, `sha512-256`, `shake128`, `shake256`, `sm3`.
1111

1212
Furthermore, secure token is created as described in RFC2104, that is,
1313
`H(secret_key XOR opad,H(secret_key XOR ipad, message))` instead of a simple `MD5(secret_key,message, expire)`.
1414

15+
Pre-built Packages (Ubuntu / Debian):
16+
=====================================
17+
18+
Pre-built packages for this module are freely available from the GetPageSpeed repository:
19+
20+
```bash
21+
# Install the repository keyring
22+
sudo install -d -m 0755 /etc/apt/keyrings
23+
curl -fsSL https://extras.getpagespeed.com/deb-archive-keyring.gpg \
24+
| sudo tee /etc/apt/keyrings/getpagespeed.gpg >/dev/null
25+
26+
# Add the repository (Ubuntu example - replace 'ubuntu' and 'jammy' for your distro)
27+
echo "deb [signed-by=/etc/apt/keyrings/getpagespeed.gpg] https://extras.getpagespeed.com/ubuntu jammy main" \
28+
| sudo tee /etc/apt/sources.list.d/getpagespeed-extras.list
29+
30+
# Install nginx and the module
31+
sudo apt-get update
32+
sudo apt-get install nginx nginx-module-hmac-secure-link
33+
```
34+
35+
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/).
36+
1537
Installation:
1638
=============
1739

18-
You'll need to re-compile Nginx from source to include this module.
40+
You'll need to re-compile Nginx from source to include this module.
1941
Modify your compile of Nginx by adding the following directive (modified to suit your path of course):
2042

2143
Static module (built-in nginx binary)

0 commit comments

Comments
 (0)