.. _Installation (for Router):

*************************
Installation (for Router)
*************************

Mudfish Cloud VPN for Router is OpenWRT based and there are two packages;
one for core process, other for OpenWRT LuCI UI.

Installation
============

Supported OpenWRT
-----------------

We currently officially support the OpenWRT version below.

* 18.06.1
* Chaos Calmer 15.05.1

Supported Routers
-----------------

The list of routers that are currently confirmed to be working properly
is as follows:

* Buffalo Inc.

  * `WZR-HP-AG300H`_

* GL.inet

  * `GL-AR300M`_

* TP-Link

  * `Archer C7 AC1750`_
  
* Western Digital

  * `My Net N750`_

* Xiaomi

  * `Mi Wi-Fi Nano / Youth (R1CL)`_
  
.. _GL-AR300M: https://www.gl-inet.com/ar300m/
.. _WZR-HP-AG300H: http://buffalo.jp/products/catalog/network/wzr-hp-ag300h/
.. _Archer C7 AC1750: https://www.tp-link.com/en/products/details/Archer-C7.html
.. _My Net N750: https://support.wdc.com/product.aspx?ID=1702
.. _Mi Wi-Fi Nano / Youth (R1CL): https://www.mi.com/miwifilite/

Dependency Packages
-------------------

In order for the Mudfish program to work properly on the router, you need
to install the following packages:

* ip

  Used to set the routing table entries for mudfish game items.

* kmod-tun: tun(4) driver

* libopenssl

* libpthread

* librt

* zlib

Individual packages for your router are available at
https://downloads.openwrt.org/ link.  You need to install it before
installing the mudfish packages.

* Mi Wi-Fi Nano / Youth (R1CL)

  https://downloads.openwrt.org/releases/18.06.1/targets/ramips/mt76x8/

  .. code-block:: bash

     # opkg update
     # opkg install kmod-tun
     # opkg install ip zlib libpthread librt libopenssl

Installation LuCi Web Interface
-------------------------------

.. code-block:: bash

   # opkg update
   # opkg install luci

Installation using opkg
-----------------------

You can use opkg command to install Mudfish package based on
`Man page of opkg`_ document.
For example, If you'd like to install 18.06.1 (for ramips-mt7628 processor)
version of Mudfish for OpenWRT, you can use the following commands:

.. code-block:: bash

   # opkg install http://mudfish.net/releases/openwrt/packages-18.06/mipsel_24kc/base/mudfish-pi_2.1.18-1_mipsel_24kc.ipk
   # opkg install http://mudfish.net/releases/openwrt/packages-18.06/mipsel_24kc/luci/luci-app-mudfish-pi_git-18.285.02627-b9e5d56-1_all.ipk

.. _Man page of opkg: https://wiki.openwrt.org/doc/techref/opkg

How to use
==========

You can see Mudfish menu at "Service -> Mudfish" after logging in using
Luci web interface (management UI).

There are two sections currently:

* Basic

  There's a button to start / stop Mudfish.  When it's started properly,
  you can see a link to access UI of Mudfish Launcher.

  Please check :ref:`Admin Page` section for details about how to use
  dashboard.

* Support Tunnel

  You can open Support Tunnel if you'd like to get a remote technical
  support.