Skip to main content

Muddog installation and updates

Supported platforms​

Check the operating system and version on the download page before downloading an installer.

Operating systemPackages and instructions
Linux x86_64.deb and .rpm packages. Requires a desktop environment that uses systemd.
Windows 10/11 x64.msi installer. The Windows package currently supports x64 only.
macOS 13 Ventura or later.dmg installer. The Universal package supports both Intel and Apple Silicon. A macOS administrator account is required to control the app.

On Linux, the package manager installs the libraries and dependencies needed to run the app. Per-app VPN on Linux also requires a systemd user session and cgroup v2. The package dependencies include nftables. Windows also supports per-app VPN. macOS supports VPN use for all internet traffic or specific IP addresses and ranges.

This guide covers version 2.x. If the download page does not yet list a 2.x installer for your operating system, check whether it has been released. For the Windows 1.0.7 .exe installer, follow the legacy version guide.

Sharing starts when the service starts

Internet sharing starts automatically after installation on Linux and Windows, and after the first launch and background service approval on macOS. The service also starts at boot afterward, so other users can use your internet connection even if you do not open the app window. Review Internet sharing before installing.

Install on Linux​

The commands below use example filenames for version 2.0.0. In a terminal, go to the directory containing your download and replace the filename with the name of the package you downloaded. Installation requires administrator privileges.

Debian / Ubuntu​

sudo apt install ./muddog_2.0.0_amd64.deb

Fedora​

sudo dnf install ./muddog-2.0.0-1.x86_64.rpm

First launch after installation​

  1. After installation, log out of your desktop and log back in.
  2. Open Muddog from your application menu.
  3. Check that the Connection screen shows your VPN and Internet sharing status.
  4. Choose a country and connect as described in Connect to the VPN.

When you install with sudo from a regular user account, that user is added to the muddog group. You must log in again for the app to receive these permissions. Run the app as a regular user; you do not need to enter a Mudfish ID or password to use the VPN.

If an administrator installed it from another account, or multiple users need to control the app, see service access permissions.

Install on Windows​

  1. If you have Muddog installed using the old .exe installer, uninstall it first from Windows Settings → Apps. If prompted to remove the existing installation, finish uninstalling it before running the MSI installer again.
  2. Run the downloaded .msi file and approve the request for administrator privileges.
  3. Follow the installation instructions. If WebView2 Runtime is missing, the installer downloads it, so an internet connection is required.
  4. Open muddog from the Start menu or desktop as a regular user.
  5. Check the service status on the Connection screen, then follow Connect to the VPN.

The default installation location is %ProgramFiles%\muddog. The installer registers and automatically starts the muddog-engine service, and adds the inbound UDP firewall rule needed by the engine. The package includes the components required for VPN and per-app VPN. You do not need to run the app as an administrator each time you use it.

Install on macOS​

  1. Open the downloaded .dmg file.
  2. Copy Muddog.app to the Applications (/Applications) folder. Running it directly from the DMG prevents background service registration.
  3. While logged in with a macOS administrator account, open the copied Muddog app.
  4. Allow Muddog to run in the background under System Settings → General → Login Items & Extensions. The names may vary depending on your macOS version.
  5. Once the app reconnects to the service, follow Connect to the VPN.

To reopen the approval screen, select Service → Background Service Settings… from the macOS menu bar. If you need to register the service, select Service → Enable Background Service. These menu items are displayed in English. Run the app itself without sudo.

Update​

If you are using the VPN, click Disconnect, then get the new installer for your operating system from the download page.

  • Linux: Close the app and run the installation command above with the new .deb or .rpm filename.
  • Windows: Close the app and run the new .msi file. The update replaces the existing MSI installation.
  • macOS: First select Service → Remove Background Service and Quit to remove the service and close the app. Replace the app in /Applications with Muddog.app from the new DMG, then reopen it and complete any required service approval.

Updating interrupts active VPN and sharing connections. After updating, reopen the app and check the VPN and sharing status. If an error says the app and service versions do not match, see Troubleshooting.

To upgrade from the legacy Linux version 1.0.7, close the old app and install the new package. If muddog_srv.service is registered, the installer stops it and disables automatic startup. Afterward, open Muddog from your application menu.

Uninstall​

Linux​

On Debian / Ubuntu, use:

sudo apt remove muddog

On Fedora, use:

sudo dnf remove muddog

Removing the package stops the service and VPN and cleans up the network routes added by Muddog. On Debian / Ubuntu, you can use sudo apt purge muddog instead of a regular removal to also remove the dedicated service account and group.

Windows​

In Windows Settings → Apps, select muddog and uninstall it. Uninstalling stops the service and VPN, cleans up VPN routes, and removes the service and the firewall rule added during installation. User settings and connection and relay logs are retained.

macOS​

  1. In the app, select Service → Remove Background Service and Quit.
  2. Once the service has been removed and the app has closed, move Muddog.app from /Applications to the Trash.

Deleting the app file first may delay cleanup of the background item. User settings and connection and relay logs are retained.

Remaining logs and stopping sharing​

Removing the package and deleting connection and relay logs are separate operations. See Connection and relay logs for the location and retention policy of remaining local records. To keep the program installed but stop sharing, you can stop the service. Your own VPN is also unavailable while the service is stopped.