Skip to content

Commit d8d9a91

Browse files
authored
Update README.md
And that's it, all the final changes. I can stop fussing now :)
1 parent ea534a5 commit d8d9a91

1 file changed

Lines changed: 18 additions & 12 deletions

File tree

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
* [What this script does](#what-this-script-does)
77
* [Before you begin](#before-you-begin)
8-
* [Example](#example)
98
* [How to install](#how-to-install)
109
* [Troubleshooting and known issues](#troubleshooting-and-known-issues)
1110
+ [Connection test failed or error returned](#connection-test-failed-or-error-returned)
@@ -31,19 +30,26 @@ Before starting the installation process, make sure you have (and know) the foll
3130
b. Have your [Global API key](https://dash.cloudflare.com/profile/api-tokens) (More info: [Global API keys](https://support.cloudflare.com/hc/en-us/articles/200167836-Managing-API-Tokens-and-Keys)).
3231
3332
2. *DNS settings:*
34-
Ensure the DNS A record(s) for the domain/zone(s) you wish to update with this script have been created (More information: [Managing DNS records](https://support.cloudflare.com/hc/en-us/articles/360019093151-Managing-DNS-records-in-Cloudflare))
33+
34+
Ensure the DNS A record(s) for the domain/zone(s) you wish to update with this script have been created (More information: [Managing DNS records](https://support.cloudflare.com/hc/en-us/articles/360019093151-Managing-DNS-records-in-Cloudflare)).
3535

36-
## Example
36+
Your DNS records should appear (or already be setup as follows) in Cloudflare:
37+
38+
(Note: Having Proxied turned on for your A records isn't necessary, but it will prevent those snooping around from easily finding out your current IP address)
3739

38-
![image](example1.png)
40+
![image](example1.png)
3941

4042
## How to install
4143

4244
1. **Activate SSH on your supported device:**
4345

44-
a. For DSM Users: Navigate to __Control Panel > Terminal & SNMP > Enable SSH service__
46+
a. For DSM Users:
47+
48+
Navigate to __Control Panel > Terminal & SNMP > Enable SSH service__
49+
50+
b. For SRM users:
4551
46-
b. For SRM users: Navigate to __Control Panel > Services > System Services > Terminal > Enable SSH service__
52+
Navigate to __Control Panel > Services > System Services > Terminal > Enable SSH service__
4753
4854
![image](example2.png)
4955

@@ -70,7 +76,7 @@ Before starting the installation process, make sure you have (and know) the foll
7076
queryurl=https://www.cloudflare.com/
7177
```
7278

73-
Note: For SRM users, break out this [Vim cheat sheet](https://coderwall.com/p/adv71w/basic-vim-commands-for-getting-started), as it's the only text editor available to you.
79+
**Note:** For SRM users, break out this [Vim cheat sheet](https://coderwall.com/p/adv71w/basic-vim-commands-for-getting-started), as it's the only text editor available to you.
7480

7581
4. **Update your DDNS settings:**
7682

@@ -98,19 +104,19 @@ For multiple domains: __subdomain.mydomain.com---vpn.mydomain.com__
98104

99105
### Connection test failed or error returned
100106

101-
This will manifest as either 1020 error; or the update attempt not showing in Cloudflare Audit logs.
107+
This will manifest as either 1020 error; or the update attempt not showing in your Cloudflare Audit logs.
102108

103-
That generally means you've not entered something correctly in the DDNS screen for your domain.
109+
That generally means you may not have entered something correctly in the DDNS screen for your domain(s).
104110

105-
Revisit Step 4 in How to install, and make sure everything is correctly entered.
111+
Revisit [Before you begin](#before-you-begin) to ensure you have all the right information, then go back to Step 4 in [How to install](#how-to-install) to make sure everything is correctly entered.
106112

107-
And you can also check your Cloudflare Audit logs to see what - if anything - has made it there with your API key (More information: [Understanding Cloudflare Audit Logs](https://support.cloudflare.com/hc/en-us/articles/115002833612-Understanding-Cloudflare-Audit-Logs). Updates using the API will appear in the Audit logs as a Rec Set action.
113+
**Handy hint:** You can also check your Cloudflare Audit logs to see what - if anything - has made it there with your API key (More information: [Understanding Cloudflare Audit Logs](https://support.cloudflare.com/hc/en-us/articles/115002833612-Understanding-Cloudflare-Audit-Logs)). Updates using the API will appear in the Audit logs as a Rec Set action.
108114

109115
### Cloudflare no longer listed as a DDNS provider after a DSM update
110116

111117
After updates to Synology DSM, you may find the file __/usr/syno/bin/ddns/cloudflare.php__ has been deleted, and __/etc.defaults/ddns_provider.conf__ reset to default settings.
112118

113-
If this occurs, simply repeat the How to install steps above.
119+
If this occurs, simply [repeat the How to install steps](#how-to-install) shown above.
114120

115121
## Default Cloudflare ports
116122
Source [Identifying network ports compatible with Cloudflare's proxy](https://support.cloudflare.com/hc/en-us/articles/200169156-Identifying-network-ports-compatible-with-Cloudflare-s-proxy)

0 commit comments

Comments
 (0)