Skip to content

Commit

Permalink
Doc updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdlaird committed Oct 11, 2020
1 parent 42d7548 commit 57dade1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/index.rst
Expand Up @@ -197,7 +197,7 @@ can be accomplished by using ``pyngrok`` to open a ``tcp`` tunnel to the desired
# Open a tunnel to MySQL with a Reserved TCP Address
ngrok.connect(3306, "tcp",
remote_addr="1.tcp.ngrok.io:12345")
options={"remote_addr": "1.tcp.ngrok.io:12345"})
We can also serve up local directories via `ngrok's built-in fileserver <https://ngrok.com/docs#http-file-urls>`_.
Expand Down Expand Up @@ -295,10 +295,10 @@ Here is an example starting ``ngrok`` in Australia, then opening a tunnel with s
from pyngrok.conf import PyngrokConfig
from pyngrok import ngrok
options = {"subdomain": "foo", "auth": "username:password"}
pyngrok_config = PyngrokConfig(region="au")
url = ngrok.connect(subdomain="foo",
auth="username:password",
url = ngrok.connect(options=options,
pyngrok_config=pyngrok_config)
Config File
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations.rst
Expand Up @@ -439,7 +439,7 @@ Now create ``server.py`` with the following code:
sock.listen(1)
# Open a ngrok tunnel to the socket
public_url = ngrok.connect(port, "tcp", remote_addr="{}:{}".format(host, port))
public_url = ngrok.connect(port, "tcp", options={"remote_addr": "{}:{}".format(host, port)})
print("ngrok tunnel \"{}\" -> \"tcp://127.0.0.1:{}/\"".format(public_url, port))
while True:
Expand Down

0 comments on commit 57dade1

Please sign in to comment.