Chapter 02

インストールと起動方法

twsnmp
twsnmp
2022.06.28に更新

TWSNMP FCをインストールする方法の説明です。

Windows版をMicrosoft Storeからインストール

Windows版は、Microsoft Storeに公開しています。(v.1.11.0から)

https://www.microsoft.com/store/apps/9NN1DG80K76M

Microsoft StoreからのインストールのほうがMicrosoftが署名したインストラーなので
安全です。
Windows Serverにインストールしたい人はリリース版をダウンロード
していただく方法があります。

リリース版のダウンロード

TWSNMP FCのリリース版を

https://github.com/twsnmp/twsnmpfc/releases

で配布しています。最新のリリースからダウンロードしてください。

ダウンロードしたらHASH値を確認することをオススメします。
Mac OS版はdmgファイル、Windows版はmsiファイル、Linux版はdebファイルのインストラーがあります。
これらは署名してあります。ZIPファイルは署名なしの実行ファイルが実行ファイルが一つだけあります。
お好きなフォルダに解凍してください。

Mac OS版のインストール

ダウンロードしたtwsnmp.dmgファイルをダブルクリックすれば、

のような使用許諾が表示されます。<同意します>をクリックすれば、

のような画面が表示されます。
twLauncherをApplicationsにドラック&ドロップすればインストールできます。

Linux版のインストール

DebianまたはUbuntuの場合は、aptコマンドでインストールできます。
Rasiberry Piも同じ方法でできます。

まず、公開鍵をインポートしてください。root権限かsudoで実行してください。

wget -O -  https://lhx98.linkclub.jp/twise.co.jp/download/twsnmp.gpg.key |  apt-key add -

OKと表示されたらインポートできています。

E: gnupg, gnupg2 and gnupg1 do not seem to be installed, but one of them is required for this operation

のようなエラーがでたら、

apt-get update && apt-get install -y gnupg2

を実行してください。

/etc/apt/source.listに

deb https://lhx98.linkclub.jp/twise.co.jp/debian bulleseye main

の行を追加してください。

apt update
apt install twsnmpfc

を実行すればインストールできます。

他のディストリビューションのLinux環境ではzipファイルをダウンロードして

/opt/twsnmpfcなどに解凍してインストールして下さい。

Windows/Mac OS版の起動ツール(GUI)からの起動方法

v1.7.0から起動ツールが付属しています。
Windowsの場合は、「スタート」ー「TWSNMP FC」ー「TWSNMP起動ツール」

をクリックしてください。

Mac OSの場合は、twLaucherを起動してください。

Window版のTWSNMP起動/設定ツールは

のような感じです。

Mac OS版は

です。

どちらのOSでも一番簡単な起動は3ステップです。

  1. データストアのフォルダを選択する
  2. 外部からのアクセスを許可しない場合はローカルをチェック、Windowsでタスクスケジューラーに登録する場合はスケジューラーにチェック
  3. <起動>ボタンをクリック

<起動>ボタンが<停止>ボタンに変われば起動できています。エラーの場合にはメッセージが表示されます。
センサープログラムもこの起動ツールから起動できます。必要なパラメータを入力して起動ボタンをクリックするだけです。

Windowsのタスクスケジューラーに登録した場合は、

のようにTWSNMPのフォルダに登録されます。

Linux/Mac OS/Windowsでのコマンドラインからの起動方法

実行ファイルを解凍したフォルダでデータストア用のフォルダを作成して起動すれば、すぐ使えます。

mkdir datastore
twsnmpfc.app --local

パラメータに--localをつけるとループバックアドレスのポートだけをオープンして起動します。起動後にブラウザーの画面も自動で表示します。--localを付けないと他のパソコンからもアクセス可能な状態になるので注意してください。起動のパラメータは、

% ./twsnmpfc.app -h
Usage of ./twsnmpfc.app:
 -cpuprofile file
   	write cpu profile to file
 -datastore string
   	Path to Data Store directory (default "./datastore")
 -host string
   	Host Name for TLS Cert
 -ip string
   	IP Address for TLS Cert
 -local
   	Local only
 -memprofile file
   	write memory profile to file
 -password string
   	Master Password (default "twsnmpfc!")
 -ping string
   	ping mode icmp or udp
 -port string
   	port (default "8080")
 -restore string
   	Restore DB file name
 -tls
   	Use TLS

です。

Windowsの場合はデフォルトで

C:\Program Files\TWSNMP FC\twsnmpfc.exe

にインストールされます。PATHなどを設定するかフルパスでコマンドを実行してください。

Linuxでパッケージからインストールした場合は、

/opt/twsnmpfc

にインストールされます。

-cpuprofile と-memprofile はデバック用なので開発しない人は気にしないでください。
-datastoreはデータを保存するディレクトリです。デフォルは"./datastore"です。-host と-ip はブラウザーからの接続をhttps(暗号化)にするためのサーバー証明書を作るための情報です。込み入った話なので別の記事に書きます。わからない場合は気にしないでください。
-localはTWSNMP FCを起動したパソコンからだけアクセス可能にしてブラウザーも自動で起動してくれます。
-passwordはTWSNMP FC内部で使用しているマスターキーのようなものです。同じ設定だと危ないので他のパソコンからもアクセスできるようにする場合は変えてください。
-portはブラウザーからアクセスするポート番号です。デフォルト "8080"です。
-tlsはhttpsでアクセスできるようにするための設定です。サーバー証明書が必要ですなければ自動生成します。この話も込み入っているので別の記事で書きます。
-pingはPINGのモードを指定します。icmpかudpを指定できます。

Linux環境でPINGのための設定

Dockerも含めてLinux環境でpingのモードをudpを指定した場合、以下のコマンドを実行しないとPINGが機能しません。
v1.5.0以降のバージョンはデフォルトでpingモードをicmpにしたためこの指定は必要ありません。

sudo sysctl -w net.ipv4.ping_group_range="0 65535"

Docker環境での起動方法

Docker環境では実行ファイルをダウンロードする必要はありません。Docker Hubで公開しています。

https://hub.docker.com/repository/docker/twsnmp/twsnmpfc

Linux環境でpingモードをudpで利用する時は少し前に書いたPINGのための設定を実行しておいてください。
以下のコマンドでTWSNMP FCを起動できます。

docker  volume create twsnmpfc 
docker  run --rm -d --net host -v twsnmpfc:/datastore twsnmp/twsnmpfc

WindowsやMac OSのデスクトップ版Docker環境の場合は、

docker  volume create twsnmpfc 
docker  run  --rm -d --sysctl net.ipv4.ping_group_range="0 65535" -p 8080:8080 -v twsnmpfc:/datastore  twsnmp/twsnmpfc

のように起動します。この場合、ARP監視やデバイスレポートの動作に制限があります。
--sysctl net.ipv4.ping_group_range="0 65535"は、PINGをudpモードで実施する時だけ必要です。

ブラウザーから動作確認

ブラウザーから

http://<TWSNMP FCのIP>:8080/

※ 8080はデフォルトのポート番号、変更した場合は合わせてください。

にアクセスすると

のような画面が表示さます。
<ログイン>ボタンをクリックしてログイン画面

を表示して初期アカウント

ユーザーID:twsnmp
パスワード:twsnmp

でログインできればインストールは成功です。

おめでとうございます!!