Skip to content

Commit

Permalink
docs: prepare for version 1.15.1 (#1003)
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia authored Dec 16, 2024
1 parent fc2baab commit a0938af
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.markdown
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# [1.15.1](https://github.com/favonia/cloudflare-ddns/compare/v1.15.0...v1.15.1) (2024-12-16)

This is a minor release that modifies the Cloudflare URLs used by the IP providers `cloudflare.trace` (the default) and `cloudflare.doh`. The IP provider `cloudflare.trace` was updated to address [recent mysterious 1034 errors from Cloudflare servers.](https://github.com/favonia/cloudflare-ddns/issues/985) Additionally, both providers have been switched away from `1.1.1.1`, eliminating the need for a detection algorithm to determine whether `1.0.0.1` is a more suitable alternative. This simplification results in cleaner code and potentially lower resource usage.

For enhanced debugging capabilities, we have introduced a new Docker tag, `edge-alpine`. This tag provides a full Alpine Linux environment, offering basic system tools and libraries. Please note that this image is larger than the standard development tag `edge` and is not minimal.

As a reminder, since 1.13.0, **the updater no longer drops superuser privileges and `PUID` and `PGID` are ignored.** Please use Docker’s built-in mechanism to drop privileges. The old Docker Compose template may grant unneeded privileges to the new updater, which is not recommended. Please review the new, simpler, and more secure template in [README](./README.markdown). In a nutshell, **remove the `cap_add` attribute and replace the environment variables `PUID` and `PGID` with the [`user: "UID:GID"` attribute](https://docs.docker.com/reference/compose-file/services/#user)**. Similar options may exist for systems not using Docker Compose.

### Bug Fixes

- **protocol:** quote unknown strings in logging ([#986](https://github.com/favonia/cloudflare-ddns/issues/986)) ([b4d52b0](https://github.com/favonia/cloudflare-ddns/commit/b4d52b00c49ede2d80a64152dd3bb23887e2344a))
- **provider:** change `cloudflare.doh` and `cloudflare.trace` URLs ([#994](https://github.com/favonia/cloudflare-ddns/issues/994)) ([eaa9c61](https://github.com/favonia/cloudflare-ddns/commit/eaa9c6183db1e2f12a7773996bcece3aaa6768fd))

### Features

- Add a new Docker image tagged `edge-alpine` that contains Alpine Linux (not minimal) ([#978](https://github.com/favonia/cloudflare-ddns/issues/978)) ([#980](https://github.com/favonia/cloudflare-ddns/issues/980)) ([21d9f94](https://github.com/favonia/cloudflare-ddns/commit/21d9f949d6e9e848fb49b6f95722bc7e39d7d72f)) ([7d8ef9a](https://github.com/favonia/cloudflare-ddns/commit/7d8ef9acffcaa56bd3b81fba09a5bff89298f3e0)) ([#981](https://github.com/favonia/cloudflare-ddns/issues/981)) ([c9f4f12](https://github.com/favonia/cloudflare-ddns/commit/c9f4f12b64c12a5cf420875839ff9fa17e198f58)) ([#982](https://github.com/favonia/cloudflare-ddns/issues/982)) ([73a4ba3](https://github.com/favonia/cloudflare-ddns/commit/73a4ba32727eee195fb36787744c371b799a4e7b)) ([#998](https://github.com/favonia/cloudflare-ddns/issues/998)) ([bd85cad](https://github.com/favonia/cloudflare-ddns/commit/bd85cad431a71e4119c0500f855f236f2fa41535))
- **provider:** add undocumented `debug.const` provider ([#966](https://github.com/favonia/cloudflare-ddns/issues/966)) ([638c1a2](https://github.com/favonia/cloudflare-ddns/commit/638c1a21068fe0fdc79bacfa8a48deb1d6ee4638))
- **provider:** add undocumented `cloudflare.trace:URL` provider ([#988](https://github.com/favonia/cloudflare-ddns/issues/988)) ([7afb1d2](https://github.com/favonia/cloudflare-ddns/commit/7afb1d2254a810ace2cbbb0d5d0ea737bb1c0c4d))

### Features

- **config:** accept CLOUDFLARE\_\* and all compatible token settings ([#948](https://github.com/favonia/cloudflare-ddns/issues/948)) ([4fc883c](https://github.com/favonia/cloudflare-ddns/commit/4fc883c45cb3068572d0fa55740ecd338c4ccd4f))
- **provider:** specify interface name ([#941](https://github.com/favonia/cloudflare-ddns/issues/941)) ([69f8cf2](https://github.com/favonia/cloudflare-ddns/commit/69f8cf2f62c533cffb7652fe6377f7a6ba8959cb))

# [1.15.0](https://github.com/favonia/cloudflare-ddns/compare/v1.14.2...v1.15.0) (2024-10-01)

This is a major release with many improvements:
Expand Down
4 changes: 2 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Certain Docker installations may have issues with the `no-new-privileges` securi
<details>
<summary><em>Click to expand:</em> ❔ I am getting <code>error code: 1034</code></summary>

We have received reports that the default IP provider, `cloudflare.trace`, has recently begun returning an "error code: 1034." The current theory is that Cloudflares servers may be experiencing internal problems. We are tracking this issue at [GitHub Issue 985](https://github.com/favonia/cloudflare-ddns/issues/985). If IP detection fails, the updater will simply retry later. You can also switch to a different IP provider.
We have received reports of recent issues with the default IP provider, `cloudflare.trace`. Some users are encountering an "error code: 1034," likely due to internal problems with Cloudflare's servers. To work around this, please upgrade the updater to version 1.15.1 or later. Alternatively, you may switch to a different IP provider.

</details>

Expand All @@ -267,7 +267,7 @@ The emoji “🧪” indicates experimental features and the emoji “🤖” in
| `CF_API_TOKEN` (will be deprecated in version 2.0.0) | Same as `CLOUDFLARE_API_TOKEN` |
| `CF_API_TOKEN_FILE` (will be deprecated version in 2.0.0) | Same as `CLOUDFLARE_API_TOKEN_FILE` |

> 🚂 Cloudflare is updating its tools to use environment variables starting with `CLOUDFLARE_*` instead of `CF_*`. It is recommended to align your setting to align with this new convention. However, the updater will fully support both `CLOUDFLARE_*` and `CF_*` environment variables until version 2.0.0.
> 🚂 Cloudflare is updating its tools to use environment variables starting with `CLOUDFLARE_*` instead of `CF_*`. It is recommended to align your setting with this new convention. However, the updater will fully support both `CLOUDFLARE_*` and `CF_*` environment variables until version 2.0.0.
>
> 🔑 To update DNS records, the updater needs the **Zone - DNS - Edit** permission.
>
Expand Down

0 comments on commit a0938af

Please sign in to comment.