mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

DOCS: Aligned/improved installation section package manager (#1788)

Browse Source
This commit is contained in:
Jeffrey Cafferata
2022-11-01 20:13:53 +01:00
committed by GitHub
parent cc433fd104
commit cd80a7f157
2 changed files with 33 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -139,60 +139,7 @@ See [Getting Started](https://stackexchange.github.io/dnscontrol/getting-started
## Installation ## Installation
### From source DNSControl can be installed via packages for macOS, Linux and Windows, or from source code. See the [official instructions](https://stackexchange.github.io/dnscontrol/getting-started#1-install-the-software).
DNSControl can be built with Go version 1.16 or higher.
The `go get` command will download the source, compile it, and
install `dnscontrol` in your `$GOBIN` directory.
To install, simply run
```shell
GO111MODULE=on go install github.com/StackExchange/dnscontrol/v3@latest
```
To download the source
```shell
git clone https://github.com/StackExchange/dnscontrol.git
```
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 or MacPorts:
```bash
# Homebrew
brew install dnscontrol
# MacPorts
sudo port install dnscontrol
````
## Via [Docker](https://hub.docker.com/r/stackexchange/dnscontrol/)
```bash
docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.json:/dns/creds.json stackexchange/dnscontrol preview
```
The documentation can be viewed via Docker:
```bash
cd docs
./runDocker.sh
```
FYI: Alternative Docker command:
```bash
docker run --rm -it --volume="$PWD:/srv/jekyll" --volume="$PWD/vendor/bundle:/usr/local/bundle" --env JEKYLL_ENV=production jekyll/jekyll:3.8 jekyll build -V
# Open docs/_site/index.html in your web browser to see the results.
# (Note: The preview isn't perfect. Links that use the site.github.url variable won't work.
```
## Via GitHub Actions (GHA) ## Via GitHub Actions (GHA)

52
docs/getting-started.md
View File

@ -7,9 +7,39 @@ title: Getting Started
## 1. Install the software ## 1. Install the software
## From source Choose one of the following installation methods:
DNSControl can be built with Go version 1.18 or higher. ### Homebrew
On macOS (or Linux) you can install it using [Homebrew](https://brew.sh).
```bash
brew install dnscontrol
```
### MacPorts
Alternatively on macOS you can install it using [MacPorts](https://www.macports.org).
```bash
sudo port install dnscontrol
````
### Docker
You can use DNSControl locally using the Docker image from [Docker hub](https://hub.docker.com/r/stackexchange/dnscontrol/) and the command below.
```bash
docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.json:/dns/creds.json stackexchange/dnscontrol preview
```
### Binaries
Download binaries from [GitHub](https://github.com/StackExchange/dnscontrol/releases/latest) for Linux (binary, tar, RPM, DEB), FreeBSD (tar), Windows (exec, ZIP) for 32-bit, 64-bit, and ARM.
### Source
DNSControl can be built from source with Go version 1.18 or higher.
The `go install` command will download the source, compile it, and The `go install` command will download the source, compile it, and
install `dnscontrol` in your `$GOBIN` directory. install `dnscontrol` in your `$GOBIN` directory.
@ -24,24 +54,6 @@ To download the source
If these don't work, more info is in [#805](https://github.com/StackExchange/dnscontrol/issues/805). 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/)
```bash
docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.json:/dns/creds.json stackexchange/dnscontrol preview
```
## 2. Create a place for the config files ## 2. Create a place for the config files
Create a directory where you'll be storing your configuration files. Create a directory where you'll be storing your configuration files.