Skip to content

Commit d21f313

Browse files
committed
docs: [#272] clarify task 7.4 implementation notes
- Validation occurs in domain layer during DTO-to-domain conversion - Grafana excluded (bind address hardcoded at port 3000) - Localhost detection: 127.0.0.1 and ::1 only - Add is_localhost_only field to ServiceInfo (not message in URL) - Show 'Internal only' for localhost services (never hide)
1 parent f143303 commit d21f313

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/issues/272-add-https-support-with-caddy.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,6 +1113,14 @@ Error: Invalid configuration for health_check_api
11131113
- Change bind_address to '0.0.0.0:1313' to expose the service through Caddy
11141114
```
11151115

1116+
**Implementation Notes**:
1117+
1118+
- Validation occurs in the domain layer when converting DTO to domain object (similar to the Grafana→Prometheus dependency validation)
1119+
- This is an internal rule per service, checked during DTO-to-domain conversion
1120+
- Services to validate: `health_check_api`, `http_api`, `http_trackers` (each individually)
1121+
- Grafana excluded: bind address is hardcoded (port 3000), not user-configurable
1122+
- Localhost detection: Check for `127.0.0.1` and `::1` (IPv6 localhost) only, not entire ranges
1123+
11161124
##### Part B: Show Command for Localhost Services (without TLS)
11171125

11181126
For services bound to localhost WITHOUT TLS, display:
@@ -1129,12 +1137,19 @@ Health Check:
11291137
- http://10.140.190.190:1313/health_check
11301138
```
11311139

1140+
**Implementation Notes**:
1141+
1142+
- Add `is_localhost_only: bool` field to `ServiceInfo` for relevant services (don't put message in URL field)
1143+
- Show "Internal only" message for localhost-bound services - never hide services from output
1144+
- Principle: Keep user informed about everything. If keeping a service internal was an error, the user catches it sooner rather than wondering why the service is missing from output.
1145+
11321146
**Implementation Scope**:
11331147

1134-
- [ ] Add validation in create command to reject localhost + TLS combinations
1148+
- [ ] Add validation in domain layer to reject localhost + TLS combinations (during DTO-to-domain conversion)
11351149
- [ ] Update show command to detect localhost-bound services
1136-
- [ ] Display appropriate message for internal-only services
1137-
- [ ] Apply to all configurable HTTP services (health check, HTTP trackers, API, Grafana)
1150+
- [ ] Add `is_localhost_only` field to `ServiceInfo` for health check, API, and HTTP trackers
1151+
- [ ] Display "Internal only" message for internal-only services
1152+
- [ ] Apply to: health check API, HTTP API, HTTP trackers (Grafana excluded - hardcoded port)
11381153

11391154
### Phase 8: Schema Generation (30 minutes)
11401155

0 commit comments

Comments
 (0)