Skip to content

docs(README): document Docker host configuration#409

Open
iamludal wants to merge 1 commit intomcuadros:masterfrom
iamludal:docs/docker-host-config
Open

docs(README): document Docker host configuration#409
iamludal wants to merge 1 commit intomcuadros:masterfrom
iamludal:docs/docker-host-config

Conversation

@iamludal
Copy link

@iamludal iamludal commented Feb 8, 2026

This pull request enhances the documentation in the README.md file by adding detailed instructions for configuring Ofelia to connect to different Docker hosts. The new section covers environment variables, usage scenarios, and examples for both socket proxy and TLS setups, making it easier for users to securely and flexibly configure Ofelia in various Docker environments.

Docker host configuration documentation:

  • Added a new section explaining how to configure Ofelia to connect to a custom Docker host using environment variables like DOCKER_HOST, DOCKER_TLS_VERIFY, DOCKER_CERT_PATH, and DOCKER_API_VERSION.
  • Provided usage examples for connecting via a Docker socket proxy, including both docker run and docker-compose configurations.
  • Included instructions and an example for connecting to a Docker host using TLS, detailing the necessary environment variables and volume mounts.

nekrich pushed a commit to nekrich/ofelia that referenced this pull request Feb 13, 2026
…cuadros#409)

## Summary

- Add new `ntfy-token` preset with Bearer token authentication for
self-hosted ntfy instances or private topics
- Clarify that the existing `ntfy` preset is for public topics only
- Remove unused `secret` variable from the `ntfy` preset (it was defined
but never used in headers)

## Changes

| File | Change |
|------|--------|
| `middlewares/presets/ntfy-token.yaml` | New preset with
`Authorization: Bearer {secret}` header |
| `middlewares/presets/ntfy.yaml` | Updated description, removed unused
secret variable |
| `docs/webhooks.md` | Added documentation for both presets with
examples |
| `middlewares/preset_test.go` | Added tests for ntfy-token preset |

## Usage

**Public topics (no auth):**
```ini
[webhook "ntfy-public"]
preset = ntfy
id = my-public-topic
```

**Private topics or self-hosted with tokens:**
```ini
[webhook "ntfy-private"]
preset = ntfy-token
url = https://ntfy.example.com/my-topic
secret = tk_AgQdq7mVBoFD37zQVN29RhuMzNIz2
```

## Related

Partially addresses mcuadros#407 - This PR adds authentication support for ntfy.
A separate PR will address the private network access (SSRF)
configuration.

## Test plan

- [x] All existing preset tests pass
- [x] New `ntfy-token` preset loads correctly
- [x] Authorization header is correctly set with Bearer token
- [x] `ntfy` preset correctly excludes Authorization header
- [x] Documentation examples are accurate
nekrich pushed a commit to nekrich/ofelia that referenced this pull request Feb 13, 2026
## Summary

Updates CHANGELOG.md with release notes for v0.17.0 including:

- **Secure Web Authentication** (mcuadros#408)
- **Doctor Command Enhancements** (mcuadros#408)
- **ntfy-token Preset** (mcuadros#409)
- **Webhook Host Whitelist** (mcuadros#410)
- **CronClock Interface** (mcuadros#412)
- **Cookie Security Hardening** (mcuadros#411)
- **GitHub Actions Pinning** (mcuadros#411)
- **Test Infrastructure Improvements** (mcuadros#412)
- **Performance Optimizations** (mcuadros#412)
- **Linting Audit** (mcuadros#413)

## Test Plan

- [x] Changelog follows Keep a Changelog format
- [x] All PR references are correct
- [x] Date is correct (2025-12-22)
nekrich pushed a commit to nekrich/ofelia that referenced this pull request Feb 13, 2026
## Summary

Adds links to PRs and Issues in each release's notes, making it easy for
users to see what changed.

### Changes

1. **Workflow update**: The `notify-released` job now adds an "Included
in this release" section with:
   - Links to all merged PRs labeled with `released:vX.Y.Z`
   - Links to all closed Issues labeled with `released:vX.Y.Z`

2. **Backfill script**: `scripts/update-release-notes.sh` updates past
release notes

### Example output in release notes

```markdown
---

## Included in this release

### Pull Requests

- [mcuadros#408](netresearch#408) feat: secure web auth
- [mcuadros#409](netresearch#409) feat: ntfy-token preset

### Issues

- [mcuadros#407](netresearch#407) Add token auth for ntfy
```

## Test Plan

- [x] Dry-run script tested
- [ ] Run update script after merge to backfill all releases
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant