docs: Add Tunnelmole as an open source alternative to ngrok #4361
Conversation
robbie-cahill
requested review from
GenPage,
nitrocode and
X-Guardian
and removed request for
a team
runatlantis.io/guide/test-drive.md
Outdated
| ## Tunnelmole Setup | ||
| First install Tunnelmole. You can check out the [Installation Guide](https://tunnelmole.com/docs/#installation). For most use cases, this will be done with a single command copy/pasted into your terminal. Running Tunnelmole can be as simple as `tmole <port>`(replace `<port>` with your listening port). In the output, you'll find an HTTP and HTTPS URL. It's recommended to use the HTTPS URL for improved privacy and security. | ||
|
|
There was a problem hiding this comment.
I would suggest removing this paragraph, as there is no ngrok setup detail in this document, so having this extra Tunnelmole detail here is confusing here if you intend to use ngrok. You already have links to the tunnelmole docs and the additional setup detail in the testling-locally.md file.
There was a problem hiding this comment.
Good point, I've removed it.
| @@ -40,30 +58,28 @@ URL="https://{YOUR_HOSTNAME}.ngrok.io" | |||
| ``` | |||
|
|
|||
| ## Create a Webhook Secret | |||
| GitHub and GitLab use webhook secrets so clients can verify that the webhooks came | |||
There was a problem hiding this comment.
The changes in this section are out of scope of your PR.
There was a problem hiding this comment.
I think the diff GitHub is showing here is a bit misleading. This section has moved to line 60, so the line "GitHub and GitLab use webhook secrets so clients can verify that the webhooks came" is still there on line 61.
There was a problem hiding this comment.
You have changed the line breaks and modified the lines of this section which has caused the Git diffs. These changes aren't really anything to do with the Tunnelmole detail you have added, so to make PRs easier to review, it is preferable if you don't make these changes in this PR.
| <details> | ||
| <summary>Expand</summary> | ||
| <summary>GitHub or GitHub Enterprise Webhook</summary> |
There was a problem hiding this comment.
If you are including changes outside the scope of your PR, please detail/justify these in the PR description.
X-Guardian
changed the title
jamengual
added
needs discussion
Co-authored-by: Simon Heather <32168619+X-Guardian@users.noreply.github.com>
Co-authored-by: Simon Heather <32168619+X-Guardian@users.noreply.github.com>
| @@ -40,30 +58,28 @@ URL="https://{YOUR_HOSTNAME}.ngrok.io" | |||
| ``` | |||
|
|
|||
| ## Create a Webhook Secret | |||
| GitHub and GitLab use webhook secrets so clients can verify that the webhooks came | |||
There was a problem hiding this comment.
You have changed the line breaks and modified the lines of this section which has caused the Git diffs. These changes aren't really anything to do with the Tunnelmole detail you have added, so to make PRs easier to review, it is preferable if you don't make these changes in this PR.
|
Can you resolve the conflicts @robbie-cahill? |
This PR adds Tunnelmole as a tunneling option.
Tunnelmole is a FOSS tunnelling solution with a growing community. It works out of the box and can be optionally self hosted with the Tunnelmole Service. Both the client and service are open source.
Example: