From 56c8d3bcf4de6dddb9080fb0b0120504ca9176c2 Mon Sep 17 00:00:00 2001 From: Timothy DeHerrera Date: Sun, 17 Sep 2023 18:13:06 -0600 Subject: [PATCH] chore: update README.md --- README.md | 65 ++++++++++++++----------------------------------------- 1 file changed, 16 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 2d4f097..44484f9 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,30 @@ Reimplementation of [cloudflare-dyndns](https://github.com/colemickens/cloudflar ## status known issues -* this is barely in maintenance mode, it seems to have been broken at times without many folks noticing, myself included * paging is not implemented -* some basic CI should be added, since I haven't officially abandoned this (yet) -* I'm wary of Cloudflare these days, YMMV +* some basic CI should be added ## building -* use cargo +`cargo build` ## usage -* simple test CLI usage - ```shell -[cole@zeph:~/code/cfdyndns]$ env | grep CLOUDFLARE - -[cole@zeph:~/code/cfdyndns]$ export CLOUDFLARE_RECORDS=test-cfdyndns.mickens.us - -[cole@zeph:~/code/cfdyndns]$ export CLOUDFLARE_APITOKEN="m1D9WwLDE6lz2hYpU_5MtkpzBpFvEYS3ZuOGB2Va" - -[cole@zeph:~/code/cfdyndns]$ cargo run - Finished dev [unoptimized + debuginfo] target(s) in 0.06s - Running `target/debug/cfdyndns` -test-cfdyndns.mickens.us (1.2.3.4 -> 72.209.157.122)... +Usage: cfdyndns [OPTIONS] + +Options: + -r, --records Comma separated DNS records to update with the host's public IP [env: + CLOUDFLARE_RECORDS=panzy.nrd.sh,panzy.nrd.sh,nrd.xp] + -t, --token recommended: The CloudFlare API token to authenticate with deprecated: The CloudFlare + API key to authenticate with, also requires email [env: CLOUDFLARE_APITOKEN] + -k, --key deprecated: The CloudFlare email to authenticate with, also requires API key [env: + CLOUDFLARE_APIKEY] + -e, --email [env: CLOUDFLARE_EMAIL=] + -v, --verbose... More output per occurrence + -q, --quiet... Less output per occurrence + -h, --help Print help + -V, --version Print version ``` ### installing as systemd service @@ -43,36 +43,3 @@ test-cfdyndns.mickens.us (1.2.3.4 -> 72.209.157.122)... ### uninstalling systemd service 1. `make uninstall-systemd` - -### example systemd journalctl log - -``` -Sep 20 15:36:40 chimera systemd[1]: Started Cloudflare-dyndns. -Sep 20 15:36:43 chimera cloudflare-dyndns[22760]: *.mickens.tv (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:44 chimera cloudflare-dyndns[22760]: mickens.tv (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:44 chimera cloudflare-dyndns[22760]: *.mickens.xxx (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:46 chimera cloudflare-dyndns[22760]: mickens.xxx (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:46 chimera cloudflare-dyndns[22760]: cole.mickens.us (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:46 chimera cloudflare-dyndns[22760]: *.mickens.us (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:47 chimera cloudflare-dyndns[22760]: mickens.us (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:47 chimera cloudflare-dyndns[22760]: *.mickens.me (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:48 chimera cloudflare-dyndns[22760]: mickens.me (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:48 chimera cloudflare-dyndns[22760]: recessionomics.us (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:49 chimera cloudflare-dyndns[22760]: www.recessionomics.us (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:49 chimera cloudflare-dyndns[22760]: *.mickens.io (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:36:49 chimera cloudflare-dyndns[22760]: mickens.io (74.125.186.11 -> 66.235.2.123)... done -Sep 20 15:41:45 chimera systemd[1]: Started Cloudflare-dyndns. -Sep 20 15:41:45 chimera cloudflare-dyndns[23288]: recessionomics.us skipped, up to date -Sep 20 15:41:45 chimera cloudflare-dyndns[23288]: www.recessionomics.us skipped, up to date -Sep 20 15:41:45 chimera cloudflare-dyndns[23288]: *.mickens.tv skipped, up to date -Sep 20 15:41:45 chimera cloudflare-dyndns[23288]: mickens.tv skipped, up to date -Sep 20 15:41:45 chimera cloudflare-dyndns[23288]: *.mickens.io skipped, up to date -Sep 20 15:41:45 chimera cloudflare-dyndns[23288]: mickens.io skipped, up to date -Sep 20 15:41:46 chimera cloudflare-dyndns[23288]: cole.mickens.us skipped, up to date -Sep 20 15:41:46 chimera cloudflare-dyndns[23288]: *.mickens.us skipped, up to date -Sep 20 15:41:46 chimera cloudflare-dyndns[23288]: mickens.us skipped, up to date -Sep 20 15:41:46 chimera cloudflare-dyndns[23288]: *.mickens.xxx skipped, up to date -Sep 20 15:41:46 chimera cloudflare-dyndns[23288]: mickens.xxx skipped, up to date -Sep 20 15:41:46 chimera cloudflare-dyndns[23288]: *.mickens.me skipped, up to date -Sep 20 15:41:46 chimera cloudflare-dyndns[23288]: mickens.me skipped, up to date -```