From c2eb98993c6f466c71bcb3657efda02168e8c2e3 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Wed, 23 Aug 2023 10:27:13 -0400 Subject: [PATCH] DOCS: Improved docker instructions (#2532) --- README.md | 8 +++++++- documentation/getting-started.md | 13 ++----------- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index cec66a659..f2d29ba01 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,13 @@ Running `dnscontrol preview` will talk to the providers (here name.com as regist Running `dnscontrol push` will make those changes with the provider and my dns records will be correctly updated. -See [Getting Started](https://docs.dnscontrol.org/getting-started/getting-started) page on documentation site. +The easiest way to run DNSControl is to use the Docker container: + +``` +docker run --rm -it -v "$(pwd):/dns" ghcr.io/stackexchange/dnscontrol preview +``` + +See [Getting Started](https://docs.dnscontrol.org/getting-started/getting-started) page on documentation site to get started! ## Benefits diff --git a/documentation/getting-started.md b/documentation/getting-started.md index cb84c2c47..bc7dc51ba 100644 --- a/documentation/getting-started.md +++ b/documentation/getting-started.md @@ -23,19 +23,10 @@ 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. +You can use DNSControl locally using the Docker image from [Docker hub](https://hub.docker.com/r/stackexchange/dnscontrol/) or [Github Container Registry](https://github.com/stackexchange/dnscontrol/pkgs/container/dnscontrol) and the command below. ```shell -docker run --rm \ - -it \ - -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js \ - -v $(pwd)/creds.json:/dns/creds.json \ - -v $(pwd)/spfcache.updated.json:/dns/spfcache.updated.json \ - -v $(pwd)/spfcache.json:/dns/spfcache.json \ - -v $(pwd)/zones/:/dns/zones/ \ - -u $(id -u ${USER}):$(id -g ${USER}) \ - stackexchange/dnscontrol \ - preview + docker run --rm -it -v "$(pwd):/dns" ghcr.io/stackexchange/dnscontrol preview ``` ### Binaries