From ebcc65f18349ce48fb8dcf8ecb6da86583062c15 Mon Sep 17 00:00:00 2001 From: Luca Comellini Date: Tue, 5 Dec 2023 10:02:06 -0800 Subject: [PATCH] Add docs about Snap (#569) --- .github/workflows/ci.yml | 2 +- README.md | 12 ++++++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f5b2c272..b6407c6d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -134,7 +134,7 @@ jobs: - Use the {{version}} image from our [DockerHub](https://hub.docker.com/r/nginx/nginx-prometheus-exporter/tags?page=1&ordering=last_updated&name={{version-number}}), [GitHub Container](https://github.com/nginxinc/nginx-prometheus-exporter/pkgs/container/nginx-prometheus-exporter), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-prometheus-exporter) or [Quay.io](https://quay.io/repository/nginx/nginx-prometheus-exporter/tag/{{version-number}}?tab=tags). - Download the latest binaries from the [GitHub releases page](https://github.com/nginxinc/nginx-prometheus-exporter/releases/tag/{{version}}). - - Update to the latest version with `brew upgrade nginx-prometheus-exporter`. + - Update to the latest version with `brew upgrade nginx-prometheus-exporter` or `snap refresh nginx-prometheus-exporter`. ## Compatibility diff --git a/README.md b/README.md index b5909415..d958120e 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ ![GitHub all releases](https://img.shields.io/github/downloads/nginxinc/nginx-prometheus-exporter/total?logo=github) ![GitHub release (latest by SemVer)](https://img.shields.io/github/downloads/nginxinc/nginx-prometheus-exporter/latest/total?sort=semver&logo=github) [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nginxinc/nginx-prometheus-exporter?logo=github&sort=semver)](https://github.com/nginxinc/nginx-prometheus-exporter/releases/latest) +[![nginx-prometheus-exporter](https://snapcraft.io/nginx-prometheus-exporter/badge.svg)](https://snapcraft.io/nginx-prometheus-exporter) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nginxinc/nginx-prometheus-exporter?logo=go) [![Docker Pulls](https://img.shields.io/docker/pulls/nginx/nginx-prometheus-exporter?logo=docker&logoColor=white)](https://hub.docker.com/r/nginx/nginx-prometheus-exporter) ![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/nginx/nginx-prometheus-exporter?logo=docker&logoColor=white&sort=semver) @@ -399,8 +400,7 @@ useful for experimenting with new features that are not yet published in a stabl ### Binaries -We publish the binaries for multiple Operating Systems and architectures on the GitHub [releases -page](https://github.com/nginxinc/nginx-prometheus-exporter/releases). +We publish the binaries for multiple Operating Systems and architectures on the GitHub [releases page](https://github.com/nginxinc/nginx-prometheus-exporter/releases). ### Homebrew @@ -416,6 +416,14 @@ and then install the formula with brew install nginx-prometheus-exporter ``` +### Snap + +You can install the NGINX Prometheus Exporter from the [Snap Store](https://snapcraft.io/nginx-prometheus-exporter). + +```console +snap install nginx-prometheus-exporter +``` + ## Building the Exporter You can build the exporter using the provided Makefile. Before building the exporter, make sure the following software