Skip to content

Commit a0ba763

Browse files
committed
improve documentation
1 parent ceb7bfb commit a0ba763

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You must have a Cloudflare account and your domain must be configured to point t
1313
2. 'Quick Edit' the worker within your browser.
1414
3. Copy and paste the contents of [index.js](https://github.com/willswire/unifi-cloudflare-ddns/blob/main/index.js) into the code editor for your worker. Ensure that you are replacing any boilerplate/code that is currently there.
1515
4. Once you have created the worker, take note of it's \*.workers.dev route. More on routes for Cloudflare Workers [here](https://developers.cloudflare.com/workers/platform/routes#routes-with-workersdev).
16-
5. Create an API token so the Worker can update your DNS records. Go to https://dash.cloudflare.com/profile/api-tokens and select "Create custom token". Enable permissions for both **Zone:Read** and **DNS:Edit**. Copy your API Key - you will need it later when configuring your UniFi OS Controller.
16+
5. Create an API token so the Worker can update your DNS records. Go to https://dash.cloudflare.com/profile/api-tokens and select "Create token". On the next page, scroll down and click the "Get Started" button next to the "Create Custom Token" label. Select **Zone:DNS:Edit** for the "Permissions" drop-down, and include your target zone under the "Zone Resources" drop-down. Copy your API Key - you will need it later when configuring your UniFi OS Controller.
1717

1818
### Configuring UniFi OS
1919
1. Log on to your [UniFi OS Controller](https://unifi.ui.com/)
@@ -25,6 +25,6 @@ You must have a Cloudflare account and your domain must be configured to point t
2525
- `Password`: the Cloudflare API Token you created earlier
2626
- `Server`: the Cloudflare Worker route `<worker-name>.<worker-subdomain>.workers.dev/update?ip=%i&hostname=%h`.
2727

28-
#### Important Note!
29-
On UniFi devices older than the UDM, the `Server` value should be configured as seen below, with no path suffix:
30-
- `<worker-name>.<worker-subdomain>.workers.dev`
28+
#### Important Notes!
29+
- If you are attempting to update a subdomain (`sub.example.com`), you must manually create an A record for it **first** in your Cloudflare dashboard.
30+
- On UniFi devices older than the UDM, the `Server` value should be configured as seen below, with no path suffix: `<worker-name>.<worker-subdomain>.workers.dev`

0 commit comments

Comments
 (0)