Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ionlights committed Dec 31, 2020
1 parent 62e200f commit 6b0e232
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions .github/README.md → README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# dns.zt
# ZeroDNS

`dns.zt` is a CoreDNS-based Docker container that allows for name resolution of your [ZeroTier][zt] peers. You should point your local machine's DNS to localhost (127.0.0.1) to enable this mapping.
![Latest ZeroDNS Release](https://github.com/ionlights/zerodns/workflows/Compile%20Release%20into%20Container/badge.svg)

`ZeroDNS` is a CoreDNS-based Docker container that allows for name resolution of your [ZeroTier][zt] peers. You should point your local machine's DNS to localhost (127.0.0.1) to enable this mapping.

## Usage

Expand All @@ -16,7 +18,7 @@ dnses: ["1.1.1.1", "1.0.0.1", ] # the default DNS, provided by Cloudflare
A likely setup would be as follows:
```
ztdns
zerodns
├── config.yml # This configuration file should be manually added
├── Corefile # This is automatically generated by DNS.zt
└── zt.hosts # This is automatically generated by DNS.zt
Expand All @@ -30,9 +32,9 @@ ztdns

**NOTE:** _Don't store this in a publicly accessible folder/repository_. It gives wide-ranging privileges to your ZeroTier account.

### Why does DNS.zt need my `access_token`?
### Why does `ZeroDNS` need my `access_token`?

We use your `access_token` to query your ZeroTier networks by name. The entire "API" is read-only, and you can validate that by looking at [tasks/ztapi.py](root/app/tasks/ztapi.py).
We use your `access_token` to query your ZeroTier networks by ID or Name. The entire "API" is read-only, and you can validate that by looking at [tasks/ztapi.py](root/app/tasks/ztapi.py).

## Current limitations

Expand Down

0 comments on commit 6b0e232

Please sign in to comment.