go2rtc/internal/ngrok

With ngrok integration, you can get external access to your streams in situations when you have Internet with a private IP address.

• you may need external access for two different things:
  • WebRTC stream, so you need a tunnel WebRTC TCP port (ex. 8555)
  • go2rtc web interface, so you need a tunnel API HTTP port (ex. 1984)
• ngrok supports authorization for your web interface
• ngrok automatically adds HTTPS to your web interface

The ngrok free subscription has the following limitations:

• You can reserve a free domain for serving the web interface, but the TCP address you get will always be random and change with each restart of the ngrok agent (not a problem for WebRTC stream)
• You can forward multiple ports from a single agent, but you can only run one ngrok agent on the free plan

go2rtc will automatically get your external TCP address (if you enable it in ngrok config) and use it with WebRTC connection (if you enable it in webrtc config).

You need to manually download the ngrok agent app for your OS and register with the ngrok service.

Tunnel for only WebRTC Stream

You need to add your ngrok authtoken and WebRTC TCP port to YAML:

ngrok:
  command: ngrok tcp 8555 --authtoken eW91IHNoYWxsIG5vdCBwYXNzCnlvdSBzaGFsbCBub3QgcGFzcw

Tunnel for WebRTC and Web interface

You need to create ngrok.yaml config file and add it to the go2rtc config:

ngrok:
  command: ngrok start --all --config ngrok.yaml

ngrok config example:

version: "2"
authtoken: eW91IHNoYWxsIG5vdCBwYXNzCnlvdSBzaGFsbCBub3QgcGFzcw
tunnels:
  api:
    addr: 1984  # use the same port as in the go2rtc config
    proto: http
    basic_auth:
      - admin:password  # you can set login/pass for your web interface
  webrtc:
    addr: 8555  # use the same port as in the go2rtc config
    proto: tcp

See the ngrok agent documentation for more details on the ngrok configuration file.