Update run-container to include short example for config #2886
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
Added a short example to explain what should actually be set as a OPENVPN_CONFIG variable. Technical deep dive is great and interesting, but should come later. The most needed basic information to use the parameter should come first, further explanation should come afterwards. Bit of background/explanation: I was so confused by what to put in the CONFIG variable that I messed around with a manual ovpn instead. Judging by haugene#2408 I'm not the only one. I realize the same explanation as in the issue is present in this wiki page, but it's far down, and opening the github page is much quicker and easier imo. (If you're in the docs you already have a browser open, but one might configure the container through portainer instead of a terminal/ssh connection)
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.
Added a short example to explain what should actually be set as a OPENVPN_CONFIG variable.
Technical deep dive is great and interesting, but should come later. The most needed basic information to use the parameter should come first, further explanation should come afterwards.
Bit of background/explanation: I was so confused by what to put in the CONFIG variable that I messed around with a manual ovpn instead. Judging by #2408 I'm not the only one. I realize the same explanation as in the issue is present in this wiki page, but it's far down, and opening the github page is much quicker and easier imo. (If you're in the docs you already have a browser open, but one might configure the container through portainer instead of a terminal/ssh connection)
Breaking change
Proposed change
Type of change
Additional information
fixes #relates to #2408https://...Checklist
If user exposed functionality or configuration variables are added/changed: