CalvinBackup/ctrld
1
0
Fork 0
mirror of https://github.com/Control-D-Inc/ctrld.git synced 2026-08-10 13:20:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3 from Control-D-Inc/cuonglm/fix-readme

Browse Source 
Update README.md
This commit is contained in:
Yegor S
2022-12-13 12:29:57 -05:00
committed by GitHub
parent b2a6f18a1c 0556825a11
commit d42ee31a7c
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -14
View File
@@ -15,29 +15,29 @@ All DNS protocols are supported, including:
## Use Cases ## Use Cases
1. Use secure DNS protocols on networks and devices that don't natively support them (legacy routers, legacy OSes, TVs, smart toasters). 1. Use secure DNS protocols on networks and devices that don't natively support them (legacy routers, legacy OSes, TVs, smart toasters).
2. Create source IP based DNS routing policies with variable secure DNS upstreams. Subnet 1 (admin) uses upstream resolver A, while Subnet 2 (employee) uses upstream resolver B. 2. Create source IP based DNS routing policies with variable secure DNS upstreams. Subnet 1 (admin) uses upstream resolver A, while Subnet 2 (employee) uses upstream resolver B.
3. Create destination IP based DNS routing policies with variable secure DNS upstreams. Listener 1 uses upstream resolver C, while Listener 2 uses upstream resolver D. 3. Create destination IP based DNS routing policies with variable secure DNS upstreams. Listener 1 uses upstream resolver C, while Listener 2 uses upstream resolver D.
4. Create domain level "split horizon" DNS routing policies to send internal domains (*.company.int) to a local DNS server, while everything else goes to another upstream. 4. Create domain level "split horizon" DNS routing policies to send internal domains (*.company.int) to a local DNS server, while everything else goes to another upstream.
## OS Support ## OS Support
- Windows (386, amd64, arm) - Windows (386, amd64, arm)
- Mac (amd64, arm) - Mac (amd64, arm64)
- Linux (386, amd64, arm, mips) - Linux (386, amd64, arm, mips)
## Download ## Download
Download pre-compiled binaries from the [Releases](#) section. Download pre-compiled binaries from the [Releases](https://github.com/Control-D-Inc/ctrld/releases) section.
## Build ## Build
`ctrld` requires `go1.19+`: `ctrld` requires `go1.19+`:
```shell ```shell
$ go build $ go build ./cmd/ctrld
``` ```
or or
```shell ```shell
$ go install <path_to_repo> $ go install github.com/Control-D-Inc/ctrld/cmd/ctrld@latest
``` ```
## Arguments ## Arguments
@@ -59,7 +59,7 @@ Flags:
Use "ctrld [command] --help" for more information about a command. Use "ctrld [command] --help" for more information about a command.
``` ```
## Usage ## Usage
To start the server with default configuration, simply run: `ctrld run`. This will create a generic `config.toml` file in the working directory and start the service. To start the server with default configuration, simply run: `ctrld run`. This will create a generic `config.toml` file in the working directory and start the service.
1. Start the server 1. Start the server
``` ```
$ sudo ./ctrld run $ sudo ./ctrld run
@@ -76,13 +76,13 @@ If `verify.controld.com` resolves, you're successfully using the default Control
## Configuration ## Configuration
### Example ### Example
- Start `listener.0` on 127.0.0.1:53 - Start `listener.0` on 127.0.0.1:53
- Accept queries from any source address - Accept queries from any source address
- Send all queries to `upstream.0` via DoH protocol - Send all queries to `upstream.0` via DoH protocol
### Default Config ### Default Config
```toml ```toml
[listener] [listener]
[listener.0] [listener.0]
@@ -118,15 +118,15 @@ If `verify.controld.com` resolves, you're successfully using the default Control
``` ```
### Advanced ### Advanced
The above is the most basic example, which will work out of the box. If you're looking to do advanced configurations using policies, see [Configuration Docs](docs/config.md) for complete documentation of the config file. The above is the most basic example, which will work out of the box. If you're looking to do advanced configurations using policies, see [Configuration Docs](docs/config.md) for complete documentation of the config file.
## Contributing ## Contributing
See [Contribution Guideline](./docs/contributing.md) See [Contribution Guideline](./docs/contributing.md)
## Roadmap ## Roadmap
The following functionality is on the roadmap and will be available in future releases. The following functionality is on the roadmap and will be available in future releases.
- Prometheus metrics exporter - Prometheus metrics exporter
- Local caching - Local caching
- Service self-installation - Service self-installation