StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-01-10 01:18:30 +08:00
Code Issues Projects Releases Packages Wiki Activity

DOCS: Update install instructions (#951)

Browse source
This commit is contained in:
Tom Limoncelli 2020-11-18 16:15:18 -05:00 committed by GitHub
parent 142b00b5ac
commit f30610065c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 42 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -117,6 +117,9 @@ See [Getting Started](https://stackexchange.github.io/dnscontrol/getting-started
DNSControl can be built with Go version 1.14 or higher.
The `go get` command will will download the source, compile it, and
install `dnscontrol` in your `$GOBIN` directory.
To install, simply run
GO111MODULE=on go get github.com/StackExchange/dnscontrol/v3
@ -146,4 +149,6 @@ docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.jso
## More info at our web site
[https://stackexchange.github.io/dnscontrol/](https://stackexchange.github.io/dnscontrol/)
The website: [https://stackexchange.github.io/dnscontrol/](https://stackexchange.github.io/dnscontrol/)
The getting started guide: [https://stackexchange.github.io/dnscontrol/getting-started](https://stackexchange.github.io/dnscontrol/getting-started)

45
docs/getting-started.md
View file

@ -7,14 +7,39 @@ title: Getting Started
## 1. Install the software
You can either download the latest
[github release](https://github.com/StackExchange/dnscontrol/releases),
or build from the go source:
## From source
go get github.com/StackExchange/dnscontrol
DNSControl can be built with Go version 1.14 or higher.
The `go get` command will will download the source, compile it, and
install `dnscontrol` in your `bin` directory.
install `dnscontrol` in your `$GOBIN` directory.
To install, simply run
GO111MODULE=on go get github.com/StackExchange/dnscontrol/v3
To download the source
git clone github.com/StackExchange/dnscontrol
If these don't work, more info is in [#805](https://github.com/StackExchange/dnscontrol/issues/805).
---
## Via packages
Get prebuilt binaries from [github releases](https://github.com/StackExchange/dnscontrol/releases/latest)
Alternatively, on Mac you can install it using homebrew:
`brew install dnscontrol`
## Via [docker](https://hub.docker.com/r/stackexchange/dnscontrol/)
```
docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.json:/dns/creds.json stackexchange/dnscontrol dnscontrol preview
```
## 2. Create a place for the config files.
@ -24,8 +49,9 @@ We highly recommend storing these files in a Git repo, but for
simple tests anything will do.
Note: Do **not** store your creds.json file in Git unencrypted.
That is unsafe. In fact you should include `creds.json` in your
`.gitignore` file. We recommend you encrypt the file using something
That is unsafe. Add `creds.json` to your
`.gitignore` file as a precaution. This file should be encrypted
using something
like [git-crypt](https://www.agwa.name/projects/git-crypt) or
[Blackbox](https://github.com/StackExchange/blackbox).
@ -257,6 +283,7 @@ Now you can make change to the domain(s) and run `dnscontrol preview`
If you are going to use this in production, we highly recommend the following:
* Store the configuration files in Git.
* Encrypt the `creds.json` file before storing it in Git.
* Use a CI/CD tool like Jenkins to automatically push DNS changes.
* Encrypt the `creds.json` file before storing it in Git. Do NOT store
API keys or other credentials without encrypting them.
* Use a CI/CD tool like Jenkins/CircleCI/Github Actions/etc. to automatically push DNS changes.
* Join the DNSControl community. File [issues and PRs](https://github.com/StackExchange/dnscontrol).