# cloudflare-domains-manager

> An easy to use tool to manage your cloudflare domains

Latest version **1.0.1** (published 2023-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install cloudflare-domains-manager
pnpm add cloudflare-domains-manager
yarn add cloudflare-domains-manager
bun add cloudflare-domains-manager
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-10-10 |
| First published | 2023-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 24.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | leen15 |

## Links

- npm: https://www.npmjs.com/package/cloudflare-domains-manager
- Repository: https://github.com/Leen15/cloudflare-domains-manager
- Issues: https://github.com/Leen15/cloudflare-domains-manager/issues
- npm.io page: https://npm.io/package/cloudflare-domains-manager

## Dependencies (5)

- [colors](https://npm.io/package/colors.md) ^1.4.0
- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [cloudflare](https://npm.io/package/cloudflare.md) ^2.9.1
- [typescript](https://npm.io/package/typescript.md) ^5.2.2

## Recent versions

- 1.0.1 (latest) — 2023-10-10
- 1.0.0 — 2023-10-10

## README

### Cloudflare Domains Manager

This tool is helpful to manage cloudflare domains using a versionated file.<br/>

## How to use?

Create a folder for your new project:
```
mkdir test-domains
cd test-domains
```

Create a new node app:
```
npm init
```

Install this package:
```
npm i cloudflare-domains-manager
```

Create a index.js with this content:
```
const CloudflareDomainsManager = require ('cloudflare-domains-manager')

const cdm = new CloudflareDomainsManager();
cdm.run();
```

Create a .env file with your clouflare data:
```
CF_EMAIL=(your cloudflare email)
CF_KEY= (your cloudflare token)
```
you can generate your cloudflare token here: https://dash.cloudflare.com/profile/api-tokens


Edit the package.json adding these lines:
```
  "main": "index.js",
  "scripts": {
    "update": "node index.js action=update",
    "list": "node index.js action=list"
  }
```

install the dependencies:
```
npm install
```

you can now get a list of your domains with:
```
npm run list
```

## The configuration file

if it works, you can now create your `configuration.yaml` file starting with something like:
```
load_balancers:
  - example-lb: &example-lb example-lb.your-infrastructure.com
  - example-lb-ip: &example-lb-ip 172.0.0.10
domains:
  - name: example.com
    zone_id: Y0UR_Z0N3_1D
    dns_records:
      - name: example.com
        type: CNAME
        content: *example-lb
        ttl: 1
        proxied: true
      - name: test.example.com
        type: A
        content: *example-lb-ip
        ttl: 1
        proxied: true
      - name: www.example.com
        type: CNAME
        content: *example-lb
        ttl: 1
        proxied: true
      - name: tobedeleted.example.com
        type: CNAME
        deleted: true
        content: *example-lb
        ttl: 1
        proxied: true
```

In the configuration:
- `ttl=1` is the automatic ttl provided by cloudflare.<br/>
- `proxied=true` means the record will be proxed by cloudflare system.<br/>
- `deleted=true` means the record will be delete from cloudflare. Use it only when you need to delete a dns record. You can remove the dns from the yaml after the deletion.<br/>

Please use load balancers mapping instead of explicit value in DNS records.<br/>


## Commands list

- `npm run list`: Get the list of all your domains in cloudflare
- `npm run update`: Update all your cloudflare domains with the content of `configuration.yaml`. Domains that don't exist in the file will be ignored
- `npm run update example.com`: Update only the domain `example.com`
- `npm run update example.com --dry-run`: Update the domain `example.com` in dry-run mode (nothing will change in cloudflare)

---
_Source: https://npm.io/package/cloudflare-domains-manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._