feat(drop): replace public gateway toggle with an optional TLS domain#38
Merged
Conversation
The previous DROP_PUBLIC_GATEWAY_ENABLED=true exposed raw Kubo on 8080/ │ tcp and produced unencrypted http://<ip>:8080/ipfs/<cid> URLs. That required a second public port and was difficult to TLS-terminate for browser clients. Now │ the public gateway is configured with DROP_PUBLIC_GATEWAY_DOMAIN. When set, a pinned Traefik v3.7.7 sidecar terminates TLS on 443/tcp, uses TLS-ALPN-01 ACME to │ obtain a certificate, and proxies only /ipfs/* to the internal Kubo gateway. The raw Kubo 8080 and admin RPC 5001 ports remain on the private Compose network and │ are never host-published. The node validates the domain, probes https://<domain>/ipfs/<cid> for reachable TLS, and advertises public_gateway_url only while │ the probe is succeeding. The installer, OpenAPI spec, WebSocket protocol docs, env example, and all operator docs are updated to match.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The previous DROP_PUBLIC_GATEWAY_ENABLED=true exposed raw Kubo on 8080/tcp and produced unencrypted http://:8080/ipfs/ URLs. That required a second public port and was difficult to TLS-terminate for browser clients.
Now the public gateway is configured with DROP_PUBLIC_GATEWAY_DOMAIN. When set, a pinned Traefik v3.7.7 sidecar terminates TLS on 443/tcp, uses TLS-ALPN-01 ACME to obtain a certificate, and proxies only /ipfs/* to the internal Kubo gateway. The raw Kubo 8080 and admin RPC 5001 ports remain on the private Compose network and are never host-published.
The node validates the domain, probes https:///ipfs/ for reachable TLS, and advertises public_gateway_url only while the probe is succeeding. The installer, OpenAPI spec, WebSocket protocol docs, env example, and all operator docs are updated to match.