Update README.md

README.md

@@ -6,6 +6,21 @@ This script is used to update Dynamic DNS (DDNS) service based on Cloudflare! Ac
 ## Support Me
 [![Donate Via Paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.me/Jasonkkf)
 
+## Table of Contents
+
+- [Cloudflare Dynamic DNS IP Updater](#cloudflare-dynamic-dns-ip-updater)
+  * [Support Me](#support-me)
+  * [Table of Contents](#table-of-contents)
+  * [Installation](#installation)
+  * [Usage](#usage)
+    + [Local variables](#local-variables)
+    + [Configuration file](#configuration-file)
+    + [Pass](#pass)
+  * [Tested Environments:](#tested-environments)
+  * [Contributing](#contributing)
+  * [Reference](#reference)
+  * [License](#license)
+
 ## Installation
 
 ```bash
@@ -27,6 +42,109 @@ This script is used with crontab. Specify the frequency of execution through cro
 # * * * * * /bin/bash {Location of the script}
 ```
 
+### Local variables
+
+If you want to use your variables inside the script fill the script with them and execute it like the following example:
+
+```bash
+./cloudflare-template.sh local
+```
+
+### Configuration file
+
+If you want to use the configuration file to store your credentials execute the following commands:
+
+```bash
+mkdir -p ~/.cloudflare
+cp config.ini ~/.cloudflare/config.ini
+
+./cloudflare-template.sh file
+```
+
+### Pass
+
+If you want to use [Pass](https://www.passwordstore.org/) you can execute the following commands:
+
+```bash
+gpg2 --full-generate-key
+```
+
+Fll the prompts:
+```text
+Please select what kind of key you want:
+
+   (1) RSA and RSA (default)
+   (2) DSA and Elgamal
+   (3) DSA (sign only)
+   (4) RSA (sign only)
+
+Your selection? 1
+
+RSA keys may be between 1024 and 4096 bits long.
+What keysize do you want? (2048) 4096
+Requested keysize is 4096 bits
+
+Please specify how long the key should be valid.
+
+        0 = key does not expire
+      <n>  = key expires in n days
+      <n>w = key expires in n weeks
+      <n>m = key expires in n months
+      <n>y = key expires in n years
+
+Key is valid for? (0) 2y
+Key expires at Sat 18 Mar 2023 15:03:38 CET
+Is this correct? (y/N) y
+
+GnuPG needs to construct a user ID to identify your key.
+
+Real name: John Doe
+Email address: john.doe@example.com
+Comment: 
+You selected this USER-ID:
+    "John Doe <john.doe@example.com>"
+
+Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O
+```
+
+List secret keys:
+
+```bash
+gpg2 --list-secret-keys --keyid-format LONG
+
+sec   4096R/AAAA2222CCCC4444 2021-03-18 [expires: 2023-03-18] uid         John Doe <jdoe@example.com>
+```
+
+Init pass:
+
+```bash
+pass init 'AAAA2222CCCC4444'
+
+mkdir: created directory ‘/home/myhome/.password-store’ Password store initialized for AAAA2222CCCC4444.
+```
+
+Execute:
+
+```bash
+pass insert -m credentials/cloudflare
+```
+
+Add your variables:
+
+```text
+auth_email=""                                       # The email used to login 'https://dash.cloudflare.com'
+auth_method=""                                      # Set to "global" for Global API Key or "token" for Scoped API Token
+auth_key=""                                         # Your API Token or Global API Key
+zone_identifier=""                                  # Can be found in the "Overview" tab of your domain
+record_name=""                                      # Which record you want to be synced
+ttl="3600"                                          # Set the DNS TTL (seconds)
+proxy="false"                                       # Set the proxy to true or false
+sitename=""                                         # Title of site "Example Site"
+slackchannel=""                                     # Slack Channel #example
+slackuri=""                                         # URI for Slack WebHook "https://hooks.slack.com/services/xxxxx"
+discorduri=""                                       # URI for Discord WebHook "https://discordapp.com/api/webhooks/xxxxx"
+```
+
 ## Tested Environments:
 macOS Mojave version 10.14.6 (x86_64) <br />
 AlmaLinux 9.3 (Linux kernel: 5.14.0 | x86_64) <br />