Installation (for Desktop)¶

Mudfish is an application which could be used to avoid the network congestion by changing the physical routing path through Mudfish VPN servers.

Please check the below table of contents:

Download ¶

The latest package found at the download section of https://mudfish.net . The packages for 32 bit and 64 bit machines are available.

For Windows ¶

Install and Uninstall ¶

Install ¶

The first screen of Mudfish installer is the component menu.

There are two components and each item installs as follows:

Mudfish - Core Binaries

Core files. Three programs are contained that Mudfish Core, Mudfish Flow Controller and Mudfish Launcher.
TAP-Win32 Adapter v9

Miniport adapter working with core programs. tap0901 driver distributed by OpenVPN technology Inc. will be installed.

Next step is an installation folder selection. In this document we assume that you install the program at C:\Program Files\Mudfish Cloud VPN ( C:\Program Files (x86)\Mudfish Cloud VPN for 64-bit machine).

After selecting the install folder then click ‘Install’ button.

If it’s your first installation for Mudfish, you could encounter the following warning messages to install TAP-Win32 Adapter v9. This network driver must be installed.

If you’re a Windows 7 user, the following dialog box could come up.

Keeps going to install.

Uninstall ¶

With Windows Explorer, please move to C:\Program Files\Mudfish Cloud VPN folder (C:\Program Files (x86)\Mudfish Cloud VPN in 64-bit machine). Just run uninstall.exe file.

It will uninstall all files and directory including TAP-Win32 Adapter v9 driver.

How to use ¶

Mudfish consists of three programs that Mudfish Core (mudfish.exe), Mudfish Flow Controller (mudflow.exe) and Mudfish Launcher (mudrun.exe). Each program’s roles are as follows:

Mudfish Core (mudfish.exe)

Core program to handle the routing table, RX/TX packets and the communication between Master server. Command line options are also available to launch it at Windows console.
Mudfish Flow Controller (mudflow.exe)

Flow controller to manage the routing table and RTT measurement.
Mudfish Launcher (mudrun.exe)

Web UI based on the reverse proxy.

Launch it!¶

Let’s launch Mudfish Launcher.

Opens “Mudfish Launcher” from “All Programs” -> Mudfish”. If you’re a Windows Vista or any later version like 7/8/8.1 and 10 user it should run as administrator privileges by right-clicking on “Mudfish Launcher” icon, and selecting “Run as administrator”.

If it works with problems, your default browser will be opened and move to http://127.0.0.1:8282

Port number could be vary that one of random number (1024 - 65535) if port 8282 is in use.

How to use Mudfish Launcher ¶

The following screen will be shown when the sign-in process was good.

Now it’s ready to use all Mudfish nodes.

Stop Mudfish ¶

Clicks the exit menu of Mudfish’s system tray icon if you want to terminate. If it’s not existed properly, the following processes should be killed by Task Manager:

mudfish.exe
mudflow.exe
mudrun.exe

For Mac OS X ¶

Install and Uninstall ¶

Install ¶

We assume that you downloaded a Mudfish package from the download page and the file extension of package is ”.dmg”. With double-clicking the file, it’ll be mounted on the OS and show the folder. You can install the Mudfish by copying the icon into Applications folder.

Like other applications, the drag-and-drop into Applications folder is all to install

Warning

Please note that just clicking the Mudfish icon on .dmg image would not work. It’s required to install it into the Applications to run.

Uninstall ¶

Like other applications, moving the application icon into Trash is all. However if you’d like to remove manually, the below command could be used to remove all files.

$ sudo rm -rf /Applications/Mudfish\ Cloud\ VPN.app/

How to use ¶

Mudfish consists of three programs that Mudfish Core (mudfish), Mudfish Flow Controller (mudflow) and Mudfish Launcher (mudrun). Each program’s roles are as follows:

Mudfish Core (mudfish)

Core program to handle the routing table, RX/TX packets and the communication between Master server. Command line options are available to launch it at console.
Mudfish Flow Controller (mudflow)

Flow controller to manage the routing table and RTT measurement.
Mudfish Launcher (mudrun)

Web UI based on the reverse proxy.

Launch it!¶

Warning

As some security reasons, running the Mudfish could be blocked with the following window:

../../_images/macosx_installer_secwarn_en.png

Then you should manually add the application at the exceptional list which is available at ‘System Preferences -> Security & Privary’ menu.

../../_images/macosx_installer_sec_en.png

When it’s launched, it’ll ask your root’s password.

../../_images/macosx_installer_auth_en.png

If it works successfully, the icon will be shown on the top-right as follow.

Please note that Mudfish requires root permission to launch because

It needs to use raw-socket interface for calculating RTT (Round Trip Time) with ICMP protocol.
It needs to modify the system routing table for redirecting the specific traffic.
It needs to launch dhclient(8) for fetching IP address.

When it’s launched, it opens a listening address at 127.0.0.1:8282 accessible with web browser using http://127.0.0.1:8282

Sign in ¶

If Mudfish Launcher is working correctly, your default browser will be launched when you click ‘Open Dashboard’ menu on the Mudfish menulet icon as follows:

How to use Mudfish Launcher ¶

The following screen will be shown when the sign-in process was good.

Now it’s ready to use all Mudfish nodes

Stop Mudfish ¶

At the Mudfish menulet icon, the exit menu is available to terminate. If you’d like to kill all Mudfish processes, the following is processes used by Mudfish application.

mudfish
mudflow
mudrun

For Linux ¶

Install and Uninstall ¶

Install ¶

We assume that that you downloaded a Mudfish package from the download page and its file extension is .sh.

$ wget http://static.loxch.com/releases/mudfish-4.3.16-linux-x86_64.sh
$ sudo sh mudfish-4.3.16-linux-x86_64.sh
Verifying archive integrity... All good.
Uncompressing Mudfish v4.3.16......
Installation is done under /opt/mudfish/4.3.16.
$ ls -l /opt/mudfish/4.3.16/bin/

At linux package, there are three executable binary files and the installation path would be always /opt/mudfish/$(VERSION)/bin/. Please note that $(VERSION) is vary depending on what version you’re installed.

Uninstall ¶

The below command could be used to remove Mudfish package.

$ sudo rm -rf /opt/mudfish/4.3.16/

How to use ¶

Mudfish consists of three programs that Mudfish Core (mudfish), Mudfish Flow Controller (mudflow) and Mudfish Launcher (mudrun). Each program’s roles are as follows:

Mudfish Core (mudfish)

Core program to handle the routing table, RX/TX packets and the communication between Master server. Command line options are available to launch it at console.
Mudfish Flow Controller (mudflow)

Flow controller to manage the routing table and RTT measurement.
Mudfish Launcher (mudrun)

Web UI based on the reverse proxy.

Launch it!¶

Let’s launch Mudfish Launcher. The version could vary depending on your package.

$ sudo /opt/mudfish/4.3.16/bin/mudrun

Mudfish requires root permission to launch because

It needs to use raw-socket interface for calculating RTT (Round Trip Time) with ICMP protocol.
It needs to modify the system routing table for redirecting the specific traffic.
It needs to launch dhclient(8) for fetching IP address.

When it’s launched, it opens a listening address at 127.0.0.1:8282 accessible with web browser using http://127.0.0.1:8282