search

ngrok / ngrok-docs

ngrok's official documentation
https://ngrok.com/docs
MIT License
51 stars 1.85k forks source link

Update docs to show how to use STOP command on a windows service to restart an agent after upgrading #476

Open ctindel opened 10 months ago

ctindel commented 10 months ago

On this page under "Update Tunnel Agent":

https://ngrok.com/docs/api/resources/tunnel-sessions/

We say that you need to restart the agent after doing an update. However the "Restart Tunnel Agent" section of the same page says that "This operation is notably not supported on Windows". So it's left unclear how to automate an update in windows.

The Update Tunnel Agent section should point out that restart command for windows doesn't work, but if they are running it as a background windows service, issuing the stop command will cause windows to automatically restart the service after it's stopped. (Honestly, this probably works on linux too if systemd is configured to auto restart but i didn't try it).

Also, the Restart section should point out the same thing regarding restarting on windows to make sure people see it in both places.

We should also point out the process in these docs too:

https://ngrok.com/docs/agent/#remote-management

As an aside, I found a typo "dyanmic" in this page, if you want to fix it while you're in there:

https://ngrok.com/docs/agent/#remote-management

ngrok-patrick commented 10 months ago

I have another Customer who has run into this, Recurrency ran into this issue