diff --git a/.goreleaser.yml b/.goreleaser.yml index e7bcd2309..b0d183176 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,4 +1,5 @@ # yaml-language-server: $schema=https://goreleaser.com/static/schema.json +project_name: dnscontrol builds: - id: build @@ -154,3 +155,62 @@ release: draft: true prerelease: auto mode: append + footer: | + ## Deprecation warnings + + > [!WARNING] + > - **32-bit binaries will no longer be distributed after September 10, 2023.** There is a proposal to stop shipping 32-bit binaries (packages and containers). If no objections are raised by Sept 10, 2023, new releases will not include them. See https://github.com/StackExchange/dnscontrol/issues/2461 for details. + > - **Call for new volunteer maintainers for NAMEDOTCOM and SOFTLAYER.** These providers have no maintainer. Maintainers respond to PRs and fix bugs in a timely manner, and try to stay on top of protocol changes. + > - **ACME/Let's Encrypt support is frozen and will be removed after December 31, 2022.** The `get-certs` command (renews certs via Let's Encrypt) has no maintainer. There are other projects that do a better job. If you don't use this feature, please do not start. If you do use this feature, please plan on migrating to something else. See discussion in [issues/1400](https://github.com/StackExchange/dnscontrol/issues/1400) + + ## Install + + #### macOS and Linux + + ##### Install with [Homebrew](https://brew.sh) (recommended) + + ```shell + brew install dnscontrol + ``` + + ##### Install with [MacPorts](https://www.macports.org) + + ```shell + sudo port install dnscontrol + ``` + + ##### Using with [Docker](https://www.docker.com) + + You can use 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). + + ```shell + docker run --rm -it -v "$(pwd):/dns" ghcr.io/stackexchange/dnscontrol preview + ``` + + #### Anywhere else + + Alternatively, you can install the latest binary (or the apt/rpm/deb/archlinux package) from this page. + + Or, if you have Go installed, you can install the latest version of DNSControl with the following command: + + ```shell + go install github.com/StackExchange/dnscontrol/v4@main + ``` + + ## Update + + Update to the latest version depends on how you choose to install `dnscontrol` on your machine. + + #### Update with [Homebrew](https://brew.sh) + + ```shell + brew upgrade dnscontrol + ``` + + ##### Install with [MacPorts](https://www.macports.org) + + ```shell + sudo port upgrade dnscontrol + ``` + + Alternatively, you can grab the latest binary (or the apt/rpm/deb package) from this page. diff --git a/README.md b/README.md index 2e6461297..ca8c92c00 100644 --- a/README.md +++ b/README.md @@ -158,12 +158,11 @@ DNSControl can be installed via packages for macOS, Linux and Windows, or from s See [dnscontrol-action](https://github.com/koenrh/dnscontrol-action) or [gacts/install-dnscontrol](https://github.com/gacts/install-dnscontrol). -## Deprecation warnings (updated 2023-02-18) +## Deprecation warnings (updated 2024-02-24) - **32-bit binaries will no longer be distributed after September 10, 2023.** There is a proposal to stop shipping 32-bit binaries (packages and containers). If no objections are raised by Sept 10, 2023, new releases will not include them. See https://github.com/StackExchange/dnscontrol/issues/2461 for details. - **Call for new volunteer maintainers for NAMEDOTCOM and SOFTLAYER.** These providers have no maintainer. Maintainers respond to PRs and fix bugs in a timely manner, and try to stay on top of protocol changes. - **ACME/Let's Encrypt support is frozen and will be removed after December 31, 2022.** The `get-certs` command (renews certs via Let's Encrypt) has no maintainer. There are other projects that do a better job. If you don't use this feature, please do not start. If you do use this feature, please plan on migrating to something else. See discussion in [issues/1400](https://github.com/StackExchange/dnscontrol/issues/1400) -- **get-zones syntax changes in v3.16** Starting in [v3.16](documentation/v316.md), the command line arguments for `dnscontrol get-zones` changes. For backwards compatibility change `provider` to `-`. See documentation for details. ## More info at our website