readme: update formatting, add infor about release
Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
parent
884a8d0336
commit
4e2e5f6365
34
README.md
34
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
|
||||
|
|
Loading…
Reference in New Issue