docs: Document ROFL proxy custom domains #2349
Open
Conversation
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
✅ Deploy Preview for oasisprotocol-oasis-sdk ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
amela
force-pushed
the
amela/docs-rofl-proxy-custom-domains
branch
5 times, most recently
from
7670f91 to
c51ba27
Compare
amela
requested review from
kostko,
matevz,
peternose and
ptrus
as code owners
ptrus
reviewed
Oct 22, 2025
ptrus
force-pushed
the
amela/docs-rofl-proxy-custom-domains
branch
from
c51ba27 to
78352ad
Compare
Member
|
I have applied my suggestions. @matevz please review |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2349 +/- ##
=======================================
Coverage 48.54% 48.55%
=======================================
Files 224 224
Lines 16079 16079
=======================================
+ Hits 7806 7807 +1
+ Misses 8213 8212 -1
Partials 60 60 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ptrus
force-pushed
the
amela/docs-rofl-proxy-custom-domains
branch
from
78352ad to
0f3e788
Compare
matevz
reviewed
Jan 7, 2026
| services in your app. Simply publish a port in your `compose.yaml` and the | ||
| proxy handles TLS certificates and routing. | ||
| The ROFL proxy automatically generates public HTTPS URLs for services in your | ||
| ROFL app. Simply publish a port in your `compose.yaml` and the proxy handles |
Member
There was a problem hiding this comment.
Please avoid using "ROFL app" and use either "ROFL" or "app".
Suggested change
| ROFL app. Simply publish a port in your `compose.yaml` and the proxy handles | |
| app. Simply publish a port in your `compose.yaml` and the proxy handles |
| @@ -1,10 +1,10 @@ | |||
| # Port Proxy | |||
| # ROFL Proxy | |||
Member
There was a problem hiding this comment.
Don't repeat ROFL in the title, because the whole part is devoted to ROFL. I'd leave the title alone or maybe change it simply to # Proxy.
Suggested change
| # ROFL Proxy | |
| # Port Proxy |
| TLS certificates and routing. | ||
|
|
||
| TLS is terminated inside the app, providing end-to-end encryption so that | ||
| TLS is terminated inside the ROFL app, providing end-to-end encryption so that |
Member
There was a problem hiding this comment.
Suggested change
| TLS is terminated inside the ROFL app, providing end-to-end encryption so that | |
| TLS is terminated inside the app, providing end-to-end encryption so that |
| ``` | ||
| After deploying your app, you can find the generated URL by | ||
| After deploying your ROFL app, you can find the generated URL by |
Member
There was a problem hiding this comment.
Suggested change
| After deploying your ROFL app, you can find the generated URL by | |
| After deploying your ROFL, you can find the generated URL by |
| route through the proxy. | ||
|
|
||
| When using `custom_domain`, you must verify ownership of the domain and complete the | ||
| routing setup. After your ROFL app is deployed, use the Oasis CLI to obtain setup |
Member
There was a problem hiding this comment.
Suggested change
| routing setup. After your ROFL app is deployed, use the Oasis CLI to obtain setup | |
| routing setup. After your app is deployed, use the Oasis CLI to obtain setup |
|
|
||
| `<published_port>` — the external port exposed in your compose.yaml | ||
|
|
||
| `<setting>` — the specific proxy configuration (e.g., mode, custom_domain) |
Member
There was a problem hiding this comment.
Suggested change
| `<setting>` — the specific proxy configuration (e.g., mode, custom_domain) | |
| `<setting>` — the specific proxy configuration (e.g., `mode`, `custom_domain`) |
| Port proxy for your ROFL automatically generates public HTTPS URLs for | ||
| services in your app. Simply publish a port in your `compose.yaml` and the | ||
| proxy handles TLS certificates and routing. | ||
| The ROFL proxy automatically generates public HTTPS URLs for services in your |
Member
There was a problem hiding this comment.
This isn't true for passthrough mode anymore.
Comment on lines
+80
to
+82
| #### `mode` | ||
|
|
||
| `net.oasis.proxy.ports.<published_port>.mode` |
Member
There was a problem hiding this comment.
Suggested change
| #### `mode` | |
| `net.oasis.proxy.ports.<published_port>.mode` | |
| #### `net.oasis.proxy.ports.<published_port>.mode` |
Comment on lines
+92
to
+94
| #### `custom_domain` | ||
|
|
||
| `net.oasis.proxy.ports.<published_port>.custom_domain` |
Member
There was a problem hiding this comment.
Suggested change
| #### `custom_domain` | |
| `net.oasis.proxy.ports.<published_port>.custom_domain` | |
| #### `net.oasis.proxy.ports.<published_port>.custom_domain` |
|
|
||
| What this configuration does: | ||
| - The application container exposes ports 8080 and 80. | ||
| - On port 8080 the proxy forwards the raw TCP connection to your application container (mode: passthrough). |
Member
There was a problem hiding this comment.
Suggested change
| - On port 8080 the proxy forwards the raw TCP connection to your application container (mode: passthrough). | |
| - On port 8080 the proxy forwards the raw TCP connection to your application container (`mode: passthrough`). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Preview: https://deploy-preview-2349--oasisprotocol-oasis-sdk.netlify.app/build/rofl/features/proxy/#configuration