update readme and an app to show websocket support #992
Conversation
This file contains 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
githubsaturn
reviewed
Oct 4, 2023
README.md
Outdated
| @@ -47,6 +47,7 @@ caproverOneClickApp: | |||
| - `dockerfileLines` which is a multiline variable, and can be used instead of `image` property in the service. You must delete the `image` property if you want to use this parameter. | |||
| - `containerHttpPort` is useful when the underlying service uses a custom port for HTTP. If not provided, the default will be `"80"` | |||
| - `notExposeAsWebApp` can be set to `"true"` when the underlying service is not an HTTP app. This is useful for databases and other internally used services. | |||
| - `websocketSupport` can be set to `"true"` to automatically enable Websocket Support. | |||
There was a problem hiding this comment.
Add a note saying that it's only supported in versions 1.12+ (future versions)
There was a problem hiding this comment.
Good point, I have adjusted the pull request to include that specification.
adding version information to websocketSupport feature
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.
I created an app with the one-click-app database recently and websocket support was not checked by default. This caused the app to not work appropriately until that was enabled. I posted in slack about this and was encouraged to submit a pull request. Please let me know if any adjustments need to be made.
I've created a pull request on the front end repo in order to handle this variable. It will enable the websocket support automatically if
true.Websocket can be checked by adding a property like the following into the template:
I tested to ensure this was not a breaking change, and was an opt in only type of feature. From my testing this is friendly to templates with or without the variable.