Mudcat · MUDFISH

イントロダクション

これはMudfish Networksが提供するHTTP/TCP/UDPポート共有サービスです。 https://ngrok.io に類似した目的のサービスを提供することを目指しています。

このサービスを使用すると、内部ネットワークのサービスを外部に簡単に共有できます。現在、以下のプロトコルをサポートしています。

HTTP
TCP
UDP

1つのコマンドを使用して簡単にインストールおよび使用することができます。

ダウンロード

プログラムは https://www.mudcat.io/ リンクからダウンロードできます。

Mudcatプログラムは1つの実行可能ファイルです。システムに簡単にダウンロードして実行できます。

Mudcatオプション

mudcatプログラムを実行すると、以下の画面が表示されます。基本的に、コマンドによってmudcatの使用方法はわずかに異なります。

$ ./mudcat 
使用方法: mudcat [-vV] <command> [<args>]

オプション:
    -v                           # 冗長なレベルを上げる。
    -V、--version                # バージョンを表示する。

コマンド:
    http                         # HTTPトンネルを作成する。
    node                         # mudcatノードを表示する。
    tcp                          # TCPトンネルを作成する。
    udp                          # UDPトンネルを作成する。

現在、サポートされているコマンドは次のとおりです。

http

HTTPポートを転送したい場合に使用できます。
node

フォワーディングに使用するmudcatノードの情報を表示します。
tcp

TCPポートを転送したい場合に使用できます。
UDP

UDPポートを転送したい場合に使用できます。

基本的に、./mudcat <command> -hを実行すると、より詳細なヘルプ情報を確認できます。

mudcat httpコマンド

このコマンドは、HTTP転送サービスを提供するために使用されます。一般的には、内部で作成しているサービスを外部に公開したい場合に使用できます。

$ ./mudcat http -h
使用方法: mudcat http [options]
    --domain <domain>            # アクセスするドメイン名を指定します。
    --local-addr <ip>            # 接続するローカルIPを指定します。デフォルト
                                 #   値は127.0.0.1です。
    --local-port <port>          # ローカルポートを指定します。デフォルト値は80です。
    --node-cc <cc>               # mudcatノードの選択を示すために国コードを指定します。
    --node-id <nid>              # mudcatノードの一意のIDを指定します。

サポートされているサブオプションは次のとおりです。

--domain <domain>

このオプションが指定されている場合、ユーザーは任意のドメインアドレス（通常は数値のアドレス）の代わりに直接ドメインを指定できます。

たとえば、--domain abcと指定すると、割り当てられたドメインアドレスはabc.mudcat.ioになります。
--local-addr <ip>

このオプションは、HTTPを転送したいローカルアドレス（IPv4）を指定します。デフォルトは127.0.0.1です。

ただし、値が必ずしも内部ネットワークアドレスを指すわけではありません。別のリモートパブリックIPを指定したい場合は、そのIPを指定できます。
--local-port <port>

HTTPを転送したいローカルポートを指定します。デフォルトは80です。
--node-cc <cc>

使用したいmudcatノードの国コードを指定できます。たとえば、国コードを「JP」と設定すると、日本のmudcatノードが自動的に割り当てられます。
--node-id <nid>

使用したいmudcatノードの一意のIDを指定できます。各リレーサーバーの一意のIDは、mudcat nodeコマンドを使用して取得できます。

mudcat nodeコマンド

このコマンドは、mudcatノードの情報を取得するために使用されます。

$ ./mudcat node -h
使用方法: mudcat node [--json-raw]
    --json-raw                   # 生のJSON出力を表示します。

./mudcat nodeコマンドを使用すると、現在実行中のmudcatノードのリストが表示されます。サポートされているサブオプションは次のとおりです。

--json-raw

リレーサーバーリストをJSON形式で出力します。

mudcat tcpコマンド

このコマンドは、TCP転送サービスを提供するために使用されます。

$ ./mudcat tcp -h
使用方法: mudcat tcp [options]
    --conn-uuid <uuid>           # 再利用する接続UUIDを設定します。
    --domain <domain>            # アクセスするドメイン名を指定します。
    --local-addr <ip>            # 接続するローカルIPを指定します。デフォルト
                                 #   値は127.0.0.1です。
    --local-port <port>          # ローカルポートを指定します。指定しない場合は、--remote-portの値が使用されます。
    --node-cc <cc>               # mudcatノードの選択を示すために国コードを指定します。
    --node-id <nid>              # mudcatノードの一意のIDを指定します。
    --remote-port <port>         # リモートポートを指定します。

サポートされているサブオプションは次のとおりです。

--conn-uuid <uuid>

以前に使用したリモートポートを再利用したい場合に使用できます。

通常割り当てられたリモートポートを使用した後に切断した場合、リモートポートはリソースが解放されるまで使用できなくなります。

ただし、以前の接続UUIDを知っている場合は、直ちにそのリモートポートを再利用できます。
--domain <domain>

このオプションが指定されている場合、ユーザーは任意のドメインアドレス（通常は数値のアドレス）の代わりに直接ドメインを指定できます。

たとえば、--domain abcと指定すると、割り当てられたドメインアドレスはabc.mudcat.ioになります。
--local-addr <ip>

このオプションは、TCPを転送したいローカルアドレス（IPv4）を指定します。デフォルトは127.0.0.1です。

ただし、値が必ずしも内部ネットワークアドレスを指すわけではありません。別のリモートパブリックIPを指定したい場合は、そのIPを指定できます。
--local-port <port>

TCPを転送したいローカルポートを指定します。このオプションが指定されていない場合、ポート情報には--remote-port <port>の値が使用されます。
--node-cc <cc>

使用したいmudcatリレーサーバーの国コードを指定できます。たとえば、国コードを「JP」と設定すると、日本のmudcatノードが自動的に割り当てられます。
--node-id <nid>

使用したいmudcatノードの一意のIDを指定できます。各リレーサーバーの一意のIDは、mudcat nodeコマンドを使用して取得できます。
--remote-port <port>

mudcatリレーサーバーでのリッスン用のTCPポートを指定します。

mudcat udpコマンド

このコマンドは、UDP転送サービスを提供するために使用されます。

$ ./mudcat udp -h
使用方法: mudcat udp [options]
    --conn-uuid <uuid>           # 再利用する接続UUIDを設定します。
    --domain <domain>            # アクセスするドメイン名を指定します。
    --local-addr <ip>            # 接続するローカルIPを指定します。デフォルト
                                 #   値は127.0.0.1です。
    --local-port <port>          # ローカルポートを指定します。指定しない場合は、--remote-portの値が使用されます。
    --node-cc <cc>               # mudcatノードの選択を示すために国コードを指定します。
    --node-id <nid>              # mudcatノードの一意のIDを指定します。
    --remote-port <port>         # リモートポートを指定します。

サポートされているサブオプションは次のとおりです。

--conn-uuid <uuid>

以前に使用したリモートポートを再利用したい場合に使用できます。

通常割り当てられたリモートポートを使用した後に切断した場合、リモートポートはリソースが解放されるまで使用できなくなります。

ただし、以前の接続UUIDを知っている場合は、直ちにそのリモートポートを再利用できます。
--domain <domain>

このオプションが指定されている場合、ユーザーは任意のドメインアドレス（通常は数値のアドレス）の代わりに直接ドメインを指定できます。

たとえば、--domain abcと指定すると、割り当てられたドメインアドレスはabc.mudcat.ioになります。
--local-addr <ip>

このオプションは、UDPを転送したいローカルアドレス（IPv4）を指定します。デフォルトは127.0.0.1です。

ただし、値が必ずしも内部ネットワークアドレスを指すわけではありません。別のリモートパブリックIPを指定したい場合は、そのIPを指定できます。
--local-port <port>

UDPを転送したいローカルポートを指定します。このオプションが指定されていない場合、ポート情報には--remote-port <port>の値が使用されます。
--node-cc <cc>

使用したいMudcatリレーサーバーの国コードを指定することができます。たとえば、国コードを'JP'に設定した場合、日本のMudcatノードが自動的に割り当てられます。
--node-id <nid>

使用したいMudcatノードのユニークIDを指定することができます。各リレーサーバーのユニークIDは、mudcat nodeコマンドを使用して取得することができます。
--remote-port <port>

Mudcatリレーサーバーでの受信に使用するUDPポートを指定します。