Skip to content

Commit

Permalink
docs: update README: add installation section (#9)
Browse files Browse the repository at this point in the history
Add information on what release artifacts are provided.
  • Loading branch information
elsbrock committed Dec 24, 2023
1 parent 99bfa9d commit 6f88b1d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ Serves Prometheus HTTP Service Discovery for devices on a Tailscale Tailnet.
For details on HTTP Service Discovery, read the Prometheus docs:
<https://prometheus.io/docs/prometheus/latest/http_sd/>

## Installation

Release builds for various architectures can be obtained from
[GitHub](https://github.com/cfunkhouser/tailscalesd/releases/latest).

There is also a
Docker image provided under `ghcr.io/cfunkhouser/tailscalesd`. The `latest` tag
is automatically updated with each release. The Docker image is available for
`arm/v7`, `arm64` and `amd64`.

## Usage

The `tailscalesd` server is very simple. It serves the SD payload at `/` on its
Expand Down

0 comments on commit 6f88b1d

Please sign in to comment.