From 4e2e5f636556877392f61f38241151278dccb530 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Soko=C5=82owski?= Date: Tue, 2 Aug 2022 16:00:35 +0200 Subject: [PATCH] readme: update formatting, add infor about release MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jakub SokoĊ‚owski --- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b40d10f..a258a3e 100644 --- a/README.md +++ b/README.md @@ -4,32 +4,38 @@ SSHFP Tool is a tool created in Golang to glue Consul DB and Cloudflare. Main purpose is creating SSHFP records to get rid of "host key verification failed". -## Building +# Building +```sh +make ``` -go mod -vendor -go build -mod vendor +Or to build for all platforms +```sh +make release ``` -## Usage +# Usage Supported env variables: -`DOMAIN_NAME` - Domain name which will be working on -`CF_TOKEN` - CloudFlare Token with write access to above domain -`HOST_LIVENESS_TIMEOUT` - number in seconds after which host is -considered as removed and dns records can be deleted -It's possible to create json formatted config file (example in `testcfg`) +* `DOMAIN_NAME` - Domain name which will be working on. +* `CF_TOKEN` - CloudFlare Token with write access to above domain. +* `HOST_LIVENESS_TIMEOUT` - After this number of seconds of host being offline DNS records are removed. -As it has been designed to work with `consul watches` passing proper .json file -to STDIN is required. Ex: -`cat watches.dump | ./sshfp-updater` +It's possible to create JSON formatted config file (example in `testcfg`) + +As it has been designed to work with `consul watches` passing proper JSON file to `stdin` is required. +```sh +cat watches.dump | ./sshfp-updater +``` + +# Current state -## Current state - CloudFlare integration is fully implemented - SSHFP Record creation based on tag in Consul form. - Implemented Consul watches integration - Implemented logic to manipulate states (merging config, etc) -## TODO: +# TODO + - A few major changes