fix: adding info about url scheme missing (#735)

from: inconshreveable/ngrok#694 --------- Signed-off-by: Russ Savage <[email protected]>
ngrok · May 16, 2024 · c552293 · c552293
1 parent 030b315
commit c552293
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 1 deletion.
diff --git a/docs/errors/details/_err_ngrok_9009.md b/docs/errors/details/_err_ngrok_9009.md
@@ -0,0 +1,3 @@
+### Additional Information
+
+If you are seeing an error such as: `ERROR: Invalid configuration property value for 'http_proxy': URL scheme must be 'http' or 'https'`, this means that you have a value set for the environment variable `http_proxy` or `http_proxy_env` and that it does not include the scheme in he value. If you are trying to use a proxy with ngrok, try updating the value of the env variable to include the proper scheme. If you are not trying to use ngrok with a proxy, then you will need to unset those env values before starting ngrok.
diff --git a/docs/using-ngrok-with.md b/docs/using-ngrok-with.md
@@ -20,8 +20,9 @@ Here you will find notes on using ngrok with particular technologies. Think we'r
 | [MySQL](/using-ngrok-with/mysql)                                   | Connect to local MySQL database with ngrok                                                                  |
 | [NGINX](/using-ngrok-with/nginx)                                   | Learn how to configure ngrok when using it with NGINX                                                       |
 | [Node (npm, node.js)](/using-ngrok-with/node-js)                   | Work with the ngrok agent from your Node application                                                        |
+| [OpenVPN Connect](/using-ngrok-with/openvpn)                       | Use ngrok to connect to an OpenVPN server running behind CGNAT                                              |
 | [Outbound proxy](/using-ngrok-with/outboundProxy)                  | Use ngrok through an HTTP or SOCKS5 proxy                                                                   |
-| [PosgreSQL](/using-ngrok-with/postgresql)                          | Connect to a local PostgreSQL server using ngrok                                                            |
+| [PostgreSQL](/using-ngrok-with/postgresql)                         | Connect to a local PostgreSQL server using ngrok                                                            |
 | [Puppet](/using-ngrok-with/puppet)                                 | Manage the ngrok Agent using Puppet                                                                         |
 | [Python](/using-ngrok-with/python)                                 | Learn how to integrate with your Python application                                                         |
 | [RDP](/using-ngrok-with/rdp)                                       | Use ngrok with Windows Remote Desktop Protocol (RDP)                                                        |

diff --git a/docs/using-ngrok-with/openvpn.md b/docs/using-ngrok-with/openvpn.md
@@ -0,0 +1,15 @@
+---
+title: OpenVPN
+---
+
+# Using ngrok with OpenVPN Connect
+
+A community user has created a detailed guide for configuring [Tunneling an OpenVPN server out from behind CGNAT](https://forums.openvpn.net/viewtopic.php?p=116476#p116476).
+
+There are a lot more details in the linked post, but the summary of how to do it with ngrok is to open a TCP tunnel to port 443, and visit the resulting TCP address and port in your browser to download the `.ovpn` file needed by OpenVPN Connect.
+
+```bash
+ngrok tcp 443
+```
+
+From there, you will need to use a text editor to manually edit the downloaded `.opvn` file to change the port from 443 to the random TCP address port provided by ngrok. Then follow the standard steps to import the profile to your OpenVPN Connect software and you should be able to connect to your VPN as normal.
diff --git a/docs/using-ngrok-with/wordpress.md b/docs/using-ngrok-with/wordpress.md
@@ -38,3 +38,13 @@ This is using the the last hop in the `X-Forwarded-For` header to set `REMOTE_AD
 If you are using a different header for the original client IP, or multiple forwarding proxies,
 you will need to adjust this code accordingly.
 :::
+
+# Troubleshooting
+
+If you are seeing an error about too many redirects (`TOO_MANY_REDIRECTS`), you may also need to add the following to your `wp-config` file as noted in [this issue](https://github.com/ngrok/ngrok/issues/3#issuecomment-2115490539):
+
+```php
+if (strpos($_SERVER['HTTP_X_FORWARDED_PROTO'], 'https') !== false) {
+    $_SERVER['HTTPS'] = 'on';
+}
+```