From 39aba3508a2fc0c89371d0af31262de8d1c4ac60 Mon Sep 17 00:00:00 2001 From: Timothy Date: Mon, 22 Apr 2019 10:16:04 +0800 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 347ba7a..f96dbac 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,17 @@ Usage of ./godns: * Configure the SMTP options if you want, a mail notification will sent to your mailbox once the IP is changed. * Save it in the same directory of GoDNS, or use -c=your_conf_path command. +## Config fields + +* provider: The providers that GoDNS supports, available values are: `Cloudflare`, `DNSPod`, `AliDNS`, `HE` . +* email: Email or account name of your DNS provider. +* password: Password of your account. +* login_token: Login token of your account. +* domains: Domains list, with your sub domains. +* ip_url: A site helps you to get your public IP address. +* interval: The interval setting for GoDNS to check your public IP changes. +* socks5_proxy: Socks5 proxy server. + ### Config example for Cloudflare For Cloudflare, you need to provide email & Global API Key as password, and config all the domains & subdomains.