Skip to content

Commit c4a5a31

Browse files
committed
added Creating Cloudflare API token
1 parent 742d97f commit c4a5a31

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,19 @@
1717
- Cloudflare [api-token](https://dash.cloudflare.com/profile/api-tokens) with ZONE-DNS-EDIT Permissions
1818
- DNS Record must be pre created (api-token should only edit dns records)
1919

20+
### Creating Cloudflare API token
21+
22+
To create a CloudFlare API token for your DNS zone go to [https://dash.cloudflare.com/profile/api-tokens][cloudflare-api-token-url] and follow these steps:
23+
24+
1. Click Create Token
25+
2. Select Create Custom Token
26+
3. Provide the token a name, for example, `example.com-dns-zone-readonly`
27+
4. Grant the token the following permissions:
28+
- Zone - DNS - Read
29+
5. Set the zone resources to:
30+
- Include - Specific Zone - `example.com`
31+
6. Complete the wizard and use the generated token at the `CLOUDFLARE_API_TOKEN` variable for the container
32+
2033
## Installation
2134

2235
You can place the script at any location manually.
@@ -154,3 +167,10 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
154167
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
155168
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
156169
IN THE SOFTWARE.
170+
171+
<!-- urls -->
172+
<!-- appendices -->
173+
174+
[cloudflare-api-token-url]: https://dash.cloudflare.com/profile/api-tokens 'Cloudflare API Token'
175+
176+
<!-- end appendices -->

0 commit comments

Comments
 (0)