docs: add pre-built Ubuntu/Debian package installation instructions#8
docs: add pre-built Ubuntu/Debian package installation instructions#8dvershinin wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughAdded a new documentation section to README.md describing pre-built package installation for Ubuntu and Debian systems via the GetPageSpeed repository, including steps to add the repository and install nginx with nginx-module-keyval. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 29: Update the README sentence that claims the module is "automatically
enabled" to clarify that while apt installation "configures the module to be
available," dynamic modules may still require an explicit load_module directive
in the main NGINX configuration; replace or amend the phrase "automatically
enabled" with language such as "configured to be available; may require manual
load_module in nginx.conf" and mention the `load_module` directive explicitly so
readers know manual configuration might be necessary while keeping the supported
distribution list unchanged.
🧹 Nitpick comments (1)
README.md (1)
20-22: Add a Debian-specific example line to reduce ambiguity.The single Ubuntu example plus “replace ‘ubuntu’ and ‘jammy’” can mislead Debian users (they also need a different distro path and codename). Consider adding a Debian example line alongside Ubuntu for clarity.
| sudo apt-get install nginx nginx-module-keyval | ||
| ``` | ||
|
|
||
| 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/). |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
GetPageSpeed nginx-module-keyval apt setup installation automatically enabled
💡 Result:
1) Set up the GetPageSpeed Extras APT repo (Debian/Ubuntu)
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
distro=$(lsb_release -is | tr '[:upper:]' '[:lower:]')
codename=$(lsb_release -cs)
echo "deb [signed-by=/etc/apt/keyrings/getpagespeed.gpg] https://extras.getpagespeed.com/${distro} ${codename} main" \
| sudo tee /etc/apt/sources.list.d/getpagespeed-extras.list
sudo apt-get update[1]
2) Install nginx-module-keyval
sudo apt-get update
sudo apt-get install nginx-module-keyval[2]
3) Is it automatically enabled?
- Maybe: GetPageSpeed’s Ubuntu/Debian instructions state that when you install NGINX and dynamic modules via
apt, “NGINX will be automatically configured to load these modules.” [3] - If it’s not loaded, you must enable it the standard NGINX way (dynamic modules require an explicit
load_module ...;in the main context) and reload NGINX. [4]
A quick check:
nginx -T 2>&1 | grep -E 'load_module|keyval' -nIf you don’t see it being loaded, add an appropriate load_module modules/…keyval….so; line near the top of /etc/nginx/nginx.conf (before http {} / stream {}), then:
sudo nginx -t && sudo systemctl reload nginx[4]
Sources:
[1] GetPageSpeed “APT Repository Setup”
[2] GetPageSpeed “keyval” (APT NGINX Extras docs)
[3] GetPageSpeed “Ubuntu: the better NGINX instructions” (auto-load claim)
[4] NGINX docs: enabling dynamic modules requires load_module
🌐 Web query:
GetPageSpeed apt supported distributions Debian 12 13 Ubuntu 20.04 22.04 24.04
💡 Result:
GetPageSpeed APT NGINX Extras repository currently publishes packages for these Debian/Ubuntu suites (amd64 + arm64), which correspond to your versions: (apt-nginx-extras.getpagespeed.com)
- Debian 12 (bookworm):
bookworm,bookworm-mainline(apt-nginx-extras.getpagespeed.com) - Debian 13 (trixie):
trixie,trixie-mainline(apt-nginx-extras.getpagespeed.com) - Ubuntu 20.04 LTS (focal):
focal,focal-mainline(apt-nginx-extras.getpagespeed.com) - Ubuntu 22.04 LTS (jammy):
jammy,jammy-mainline(apt-nginx-extras.getpagespeed.com) - Ubuntu 24.04 LTS (noble):
noble,noble-mainline(apt-nginx-extras.getpagespeed.com)
Citations:
- 1: https://apt-nginx-extras.getpagespeed.com/distributions/
- 2: https://apt-nginx-extras.getpagespeed.com/distributions/
- 3: https://apt-nginx-extras.getpagespeed.com/distributions/
- 4: https://apt-nginx-extras.getpagespeed.com/distributions/
- 5: https://apt-nginx-extras.getpagespeed.com/distributions/
- 6: https://apt-nginx-extras.getpagespeed.com/distributions/
Correct "automatically enabled" claim. GetPageSpeed's documentation states that modules are "automatically configured to load" when installed via apt, but dynamic modules require an explicit load_module directive to be loaded in the main NGINX configuration if not auto-loaded. The README overstates the automation; clarify that manual configuration may be required. The supported distribution list (Debian 12/13, Ubuntu 20.04/22.04/24.04, amd64 and arm64) is accurate.
🤖 Prompt for AI Agents
In `@README.md` at line 29, Update the README sentence that claims the module is
"automatically enabled" to clarify that while apt installation "configures the
module to be available," dynamic modules may still require an explicit
load_module directive in the main NGINX configuration; replace or amend the
phrase "automatically enabled" with language such as "configured to be
available; may require manual load_module in nginx.conf" and mention the
`load_module` directive explicitly so readers know manual configuration might be
necessary while keeping the supported distribution list unchanged.
| Pre-built Packages (Ubuntu / Debian) | ||
| ------------------------------------ | ||
|
|
||
| Pre-built packages for this module are freely available from the GetPageSpeed repository: |
There was a problem hiding this comment.
Doesn't GetPageSpeed require a subscription?
2 participants
This PR adds installation instructions for pre-built Ubuntu/Debian packages from the GetPageSpeed repository.
The packages are available for:
This makes it easier for users to install the module without compiling from source.
Summary by CodeRabbit