Skip to content

Commit

Permalink
🎉 Release of add-on Caddy 2 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
einschmidt committed Sep 15, 2024
1 parent b56d86f commit a3b518e
Show file tree
Hide file tree
Showing 5 changed files with 210 additions and 125 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,10 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[addon-caddy-2]: https://github.com/einschmidt/addon-caddy-2/tree/v1.5.8
[addon-doc-caddy-2]: https://github.com/einschmidt/addon-caddy-2/blob/v1.5.8/README.md
[addon-caddy-2]: https://github.com/einschmidt/addon-caddy-2/tree/v2.0.0
[addon-doc-caddy-2]: https://github.com/einschmidt/addon-caddy-2/blob/v2.0.0/README.md
[caddy-2-issue]: https://github.com/einschmidt/addon-caddy-2/issues
[caddy-2-version-shield]: https://img.shields.io/badge/version-v1.5.8-blue.svg
[caddy-2-version-shield]: https://img.shields.io/badge/version-v2.0.0-blue.svg
[caddy-2-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[caddy-2-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[caddy-2-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
Expand Down
55 changes: 54 additions & 1 deletion caddy-2/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,58 @@
⚠️ This release includes a breaking change in configuration management—please read the following instructions carefully to ensure a smooth transition. ⚠️

## What’s changed

### Overview

In this release, the configuration management for the Caddy 2 add-on has been updated. The primary change involves moving from the previous access-based configuration method to a new approach using the add-on configuration folder. This adjustment aims to streamline configuration handling and improve consistency across setups.

### What’s New

- **Configuration Management**: The add-on now exclusively uses the `/addon_configs/c80c7555_caddy-2` directory for configuration files. This includes:
- **`Caddyfile`**: Any custom configuration settings previously placed in other directories should now be moved to this folder.
- **Custom Caddy Binaries**: If you are using a custom build of Caddy, place the `caddy` binary file into this directory.

### What You Need to Do

To ensure a smooth transition and continued operation of your Caddy 2 setup, please follow these steps:

1. **Stop the Current Add-On**: Before making any changes, stop the currently running Caddy 2 add-on to prevent any potential issues during the transition.

2. **Update the Add-On**: Ensure you are using the latest version of the Caddy 2 add-on. This update includes the changes to the configuration management.

3. **Move `Caddyfile`**: If you have a `Caddyfile` for custom configurations, transfer it to the new add-on configuration folder:
```
/addon_configs/c80c7555_caddy-2
```

4. **Move Custom Caddy Binaries**: If you are using a custom Caddy binary, place the `caddy` binary file into the same folder.

5. **Restart the Add-On**: Start the updated Caddy 2 add-on. It will now utilize the files located in the configuration directory.

By following these steps, you will ensure that the transition to the new configuration management approach is completed smoothly, with your Caddy 2 setup functioning as expected.

### Why This Change?

- **Simplified Configuration Management**: Consolidating configuration files and custom binaries into a single directory makes management easier and avoids confusion with file paths.
- **Increased Security**: By using the add-on configuration folder, the add-on no longer requires access to the Home Assistant configuration folder. This restriction on access rights enhances security by reducing potential exposure of sensitive Home Assistant files.

### Need Help?

If you encounter any issues or have questions about this change, please refer to the updated documentation.

## 🚨 Breaking changes

- Refactor Configuration Management: Switch from Access-Based to Add-On Configuration for Caddy 2 @einschmidt (#229)

## ⬆️ Dependency updates

- ⬆️ Update caddyserver/caddy to v2.8.4 @renovate (#217)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.0.1 @renovate (#218)
- ⬆️ Update alpine_3_20/nss-tools to v3.101-r0 @renovate (#219)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.1.0 @renovate (#220)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.1.1 @renovate (#221)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.1.2 @renovate (#222)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.1.3 @renovate (#223)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.2.0 @renovate (#224)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.2.1 @renovate (#225)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.3.0 @renovate (#226)
- ⬆️ Update ghcr.io/hassio-addons/base Docker tag to v16.3.1 @renovate (#227)
Loading

0 comments on commit a3b518e

Please sign in to comment.