adds build badge & install documentation

This commit is contained in:
2025-01-19 19:00:57 +01:00
parent 3f7db7d700
commit c07330d7dd

View File

@@ -2,12 +2,21 @@
Used for advertising traefik config definitions from peer through etcd KV store.
## Configuration
[![Build Status](https://drone.schleppe.cloud/api/badges/KevinMidboe/traefik-etcd-advertiser/status.svg)](https://drone.schleppe.cloud/KevinMidboe/traefik-etcd-advertiser)
# Install
Install replacing `OS` and `ARCH`, e.g. `linux-amd64`. See [all releases](https://github.com/KevinMidboe/traefik-etcd-advertiser/releases/latest):
```bash
wget https://github.com/kevinmidboe/traefik-etcd-advertiser/releases/LATEST > /usr/bin/local/traefik-etcd-advertiser
curl -s -L https://github.com/KevinMidboe/traefik-etcd-advertiser/releases/latest/download/traefik-etcd-advertiser-OS-ARCH.tar | tar xvz
# verify install
./traefik-etcd-advertiser-linux-amd64 -version
```
## Configuration
either create `.env` configuration file or prefix environmental variables required for etcd connection:
```bash