From 309fca053495b2c8c031e85fc064afdbc4561fb3 Mon Sep 17 00:00:00 2001 From: Danila Vershinin Date: Tue, 3 Feb 2026 16:24:58 +0800 Subject: [PATCH] docs: add pre-built Ubuntu/Debian package installation instructions --- README.md | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0303c63..daeffd2 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Table of Contents * [Check_module](#check_module_support) * [TODO](#todo) * [Compatibility](#compatibility) +* [Pre-built Packages (Ubuntu / Debian)](#pre-built-packages-ubuntu--debian) * [Installation](#installation) * [Code style](#code-style) * [Author](#author) @@ -162,7 +163,7 @@ This module provides a method to discover backend servers. Supporting dynamicly * stability - Even if one pulling failed, it will pull next upsync_interval, so guarantying backend server stably provides service. And support dumping the latest config to location, so even if consul/etcd hung up, and nginx can be reload anytime. + Even if one pulling failed, it will pull next upsync_interval, so guarantying backend server stably provides service. And support dumping the latest config to location, so even if consul/etcd hung up, and nginx can be reload anytime. * health_check @@ -200,7 +201,7 @@ The parameters' meanings are: when strong_dependency is on, nginx will pull servers from consul/etcd every time when nginx start up or reload. -[Back to TOC](#table-of-contents) +[Back to TOC](#table-of-contents) upsync_dump_path ----------- @@ -212,7 +213,7 @@ context: upstream description: dump the upstream backends to the $path. -[Back to TOC](#table-of-contents) +[Back to TOC](#table-of-contents) upsync_lb ----------- @@ -224,7 +225,7 @@ context: upstream description: mainly for least_conn and hash consistent, when using one of them, you must point out using upsync_lb. -[Back to TOC](#table-of-contents) +[Back to TOC](#table-of-contents) upstream_show ----------- @@ -252,7 +253,7 @@ curl http://127.0.0.1:8500/upstream_list; show all upstreams. ``` -[Back to TOC](#table-of-contents) +[Back to TOC](#table-of-contents) Consul_interface ====== @@ -318,7 +319,7 @@ or curl http://$consul_ip:$port/v1/kv/upstreams/$upstream_name?recurse ``` -[Back to TOC](#table-of-contents) +[Back to TOC](#table-of-contents) Etcd_interface ====== @@ -358,7 +359,7 @@ mainly like etcd, http_interface example: curl http://$etcd_ip:$port/v2/keys/upstreams/$upstream_name ``` -[Back to TOC](#table-of-contents) +[Back to TOC](#table-of-contents) Check_module ====== @@ -406,7 +407,7 @@ http { } ``` -[Back to TOC](#table-of-contents) +[Back to TOC](#table-of-contents) TODO ==== @@ -424,6 +425,30 @@ The branch of nginx-upsync-1.8.x is compatible with Nginx-1.8.x and with tengine [Back to TOC](#table-of-contents) +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-upsync +``` + +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/). + +[Back to TOC](#table-of-contents) + Installation ============ @@ -502,5 +527,3 @@ source dependency * http-parser: https://github.com/nodejs/http-parser [back to toc](#table-of-contents) - -