WireGuard VPN - peer-to-site (on router) #378
Conversation
Update WireGuard VPN diagram and configuration
|
Apologies, I committed this diagram directly to the main, without a proper peer review. |
s-makin
left a comment
s-makin
left a comment
There was a problem hiding this comment.
Thanks @MariaBego56 for submitting this change. Unfortunately, the preview of the diagram isn't rendering correctly yet. I've left suggestions for how to fix it below - I'll have to review after that's been fixed :)
|
|
||
| In this diagram, we are depicting a home network with some devices and a router where we can install WireGuard. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
The rendered preview isn't rendering as a mermaid diagram because Sphinx sees the triple backticks and thinks it's a code block. Instead of the code block backticks, you need to wrap the mermaid code in:
:::{mermaid}
<diagram bits>
:::
Or something like that :)
There was a problem hiding this comment.
You can check if it's rendered properly by running the make clean followed by make run commands in your terminal, and then opening the local preview.
There was a problem hiding this comment.
Good morning @s-makin !
Thank you for your help and I am sorry I used the backticks in the wrong place :-(
I will do more work over the weekend. Thank you again. :-)
There was a problem hiding this comment.
No apology needed, mermaid can be fiddly at first :)
|
This PR has been superseded by #391 - closing this PR in favour of that one |
2 participants
Update WireGuard VPN diagram and configuration
Description
Please provide a clear and concise description of your changes. Explain what this pull request accomplishes and *
why* it is needed.
Related Issue
If this pull request addresses an existing issue, please link to it below. Use the
Fixes #<issue-number>syntax toclose the issue automatically when the pull request is merged.
Example:
Contributor License Agreement (CLA)
By contributing to this project, you agree to the terms of
the Canonical Contributor License Agreement (CLA).
If you have not already signed the CLA, please do so here.
Commit Message for Squash Merge
We typically squash commits when merging. You can specify the commit message that should be used in this case if you wish.
Provide the desired commit message below:
[(optional) category] Brief description of changes made, and why
Checklist
Additional Notes (Optional)
Add any extra information or context that reviewers may need to know. This could include testing instructions,
screenshots, or links to related discussions.
Thank you for contributing to the Ubuntu Server documentation!