ModsFinder

Engrok

by magicquartz

Engrok opens an Ngrok tunnel on a dedicated server automatically once the server starts, and publishes the address for players to find.

FabricServer-side onlyMIT LicenseOpen source1.20.1 – 1.21.1

What it does

Once the server starts, Engrok opens an Ngrok tunnel without any manual step. The address can be shared through a GitHub Gist: each time the tunnel changes, the mod uploads the new IP to a Gist, and players who use the companion Ever Changing mod can fetch it directly from there, so connection details stay current even when the address moves.

Server owners set the Ngrok authentication token, the GitHub authentication token and the Gist ID through the engrok setNgrokAuth, setGitHubAuth and setGistId commands. Each command writes to the mod's config file, and leaving a parameter blank clears that value. A tunnel can be opened, closed and checked with the tunnel commands, and the gist commands show the stored IP and URL.

Engrok runs on a server only. Players join without installing it, and the server needs Fabric API and Cloth Config API alongside it. Files are published for Fabric, for 1.20.1 and 1.21.1, under the MIT License, and the source code is public.

Key features

  1. Automatic tunnel on start

    The Ngrok tunnel opens by itself after the dedicated server starts, with no extra command needed.

  2. Tunnel control commands

    The tunnel open, tunnel close and tunnel status commands open or close the tunnel and report whether it is running and which address it uses.

  3. GitHub Gist publishing

    The current tunnel IP is uploaded to a GitHub Gist, which either creates a new Gist or updates an existing one set in the config.

  4. Gist lookup

    The gist getIp and gist getUrl commands return the stored address and the Gist link to share with friends.

Compatibility

Latest build for each game version and loader.

1.21.11.0-1.21.1
1.20.11.0-1.20.1
ReleaseBetaAlphaNot available

Only full game releases are shown. This mod publishes no snapshot builds.

Requirements

Dependencies declared by the latest file for each loader.

Required 2

Fabric APILightweight and modular API providing common hooks and intercompatibility measures utilized by mods using the Fabric toolchain.
Required
Cloth Config APIConfiguration Library for Minecraft Mods
Required

Use cases

Who it’s for: Owners of dedicated Fabric servers that run behind a router without a public IP and who want the tunnel to open without manual setup.

How it compares

Full comparison

Engrok is server-side only, while Ngrok LAN is client-side only and covers 1.18.2 – 1.20.2, so the two solve different parts of the job. Text Tunnels is also client-side only and open source under the GNU General Public License v3.0 or later, for 1.21 – 26.3. TeamLink is a client-side mod for 1.20.1 – 1.21.11 that is not open source.

ModLoadersGame versionsEnvironmentUpdated
EngrokFabric1.20.1 – 1.21.1Server-side only2024-09-21
Ngrok LANFabric1.18.2 – 1.20.2Client-side only2023-09-26
Text TunnelsFabric1.21 – 26.3Client-side only2026-10-05
TeamLinkFabric1.20.1 – 1.21.11Client-side only2026-03-01

Questions

Does Engrok need Fabric API and Cloth Config API?

Yes. Both are required dependencies and must be installed on the server next to Engrok.

Does a player need to install Engrok?

No. Players join without it, since only the server has to run the mod.

Can the tunnel address be shared without a server console?

Yes. The address is written to a GitHub Gist once a Gist ID and GitHub token are set, and friends can read it through Ever Changing.

In the catalog

Engrok is one of 5,392 Social mods on ModsFinder, and one of 4,084 Social mods for Fabric. 32,366 mods support Minecraft 1.21.1.

More from magicquartz

All projects

Similar mods

What the author says

Engrok is a server-side mod for dedicated servers which opens an Ngrok tunnel automatically once the server starts. There's an integration for GitHub Gists which uploads the Ngrok tunnel IP to a GitHub Gist (an existing one or a new one, depending on the mod's config - if there isn't an existing one, a new one will…
magicquartz, on the Modrinth page

Official listing

Owner
magicquartz
Published
2024-02-09
Updated on Modrinth
2024-09-21
Facts verified
2026-10-15

Tags