Serposcopeの公式インストール手順【日本語】

Serposcopeの公式インストール手順
https://serposcope.serphacker.com/en/doc/install.html

上記を日本語に訳しました。
単純に訳しただけではなく、わかりやすく情報を最小限で追加しています。

「検索した記事のインストール手順では、上手くインストールできない」
「インストールできたけど、イマイチよくわからない」
「設定変更したい場合に、わけがわからない」

Serposcopeのインストールに関して、このように思う方向けの記事となります。

本記事の内容

Serposcopeの依存関係
SerposcopeのWindowsへのインストール手順
SerposcopeのUbuntuとDebianへのインストール手順
SerposcopeのUbuntuとDebianへのインストール手順
SerposcopeのMac、CentOS、その他のUnixディストリビューションへのインストール手順
Serposcopeのデータディレクトリと重要なファイル
Serposcopeの高度な設定
Serposcopeの公式インストール手順【日本語】のまとめ

公式のインストール手順には、本質が詰まっています。
本質を理解すれば、応用もきかせやすくなります。

一度、じっくりと公式のインストール手順を確認してください。

Serposcopeの依存関係

Serposcopeの利用には、Java8が必要です。
お使いのOSでJavaが正しく設定されているかどうかを確認するには、java -versionを実行してください。

下記は、Linux（Debian）で確認した場合です。

# java -version
openjdk version "1.8.0_252"
OpenJDK Runtime Environment (build 1.8.0_252-8u252-b09-1~deb9u1-b09)
OpenJDK 64-Bit Server VM (build 25.252-b09, mixed mode)

Serposcope2からは、唯一の依存関係になっています。
データベースとHTTPサーバーが組み込まれ、設定がしやすくなりました。

また、キャプチャ突破サービスでアカウントを作成することを強くお勧めします。
キャプチャ突破サービスについては、以下の記事で解説しています。

重要なお知らせ :Serposcopeは初回起動時に30秒程度かかる場合があります。

SerposcopeのWindowsへのインストール手順

Windowsへのインストール

windows版をダウンロードして、管理者として実行してください。
あとは、インストーラーの指示に従ってください。

指示に従えば、Serposcopeがインストールされます。
インストール完了後は、次のURLでSerposcopeの起動を確認します。
http://127.0.0.1:7134/

Serposcopeは、Windowsが起動するたびに自動的に立ち上がります。
スタートメニューには、serposcopew.exeまたはserposcope-monitorが登録されています。
これらのメニューを使って、Serposcopeを監視/再起動してください。

Java64 Windows版

64ビットのWindowsバージョンを実行している場合でも、ほとんどの場合、システムは32ビットのJavaを使用しています。
Java64版のSerposcopeは、64ビットのJavaを使用しているWindowsシステム専用です。
Java64版のSerposcopeを試す前に、必ず「32ビット版と64ビット版」を試してみてください。

64ビットと32ビットのどちらJavaを使用しているかを確認する方法は、以下です。
コマンドプロンプト（cmd.exe）でjava -versionを実行します。

64ビットのJVMの場合

java version "1.8.0_73"
Java(TM) SE Runtime Environment (build 1.8.0_73-b02)
Java HotSpot(TM) 64-Bit Server VM (build 25.73-b02, mixed mode)

32ビットのJVMの場合

java version "1.8.0_73"
Java(TM) SE Runtime Environment (build 1.8.0_73-b02)
Java HotSpot(TM) Client VM (build 25.73-b02, mixed mode)

SerposcopeのUbuntuとDebianへのインストール手順

まず、Javaのバージョンが1.8以上であるかどうかの確認です。
ターミナルを開いてjava -versionを実行し、1.8以上のバージョンであることを確認します。

admin@localhost:~$ java -version
java version "1.8.0_66"

UbuntuにJava1.8をインストールするための推奨される方法は、次の方法です。
WebUpd8のPPAリポジトリを使用すること。

sudo apt-get -y install software-properties-common
sudo add-apt-repository -y ppa:webupd8team/java
sudo apt-get update
sudo apt-get -y install oracle-java8-installer

より多くの情報は、次のウェブサイトで見つけることができます。

Java 8 on ubuntu.　
Java 8 on debian.

別の方法でJavaをセットアップした場合は、環境変数JAVA_HOMEが定義されていることを確認してください。
JAVA_HOMEには、Javaのインストールフォルダが含まれています。

例えば、/opt/java/1.8にJavaをインストールした場合で説明します。
Javaのバイナリは/opt/java/1.8/bin/javaとなります。
そして、JAVA_HOMEには/opt/java/1.8が設定されています。

JAVA_HOMEについての詳細はこちらをご覧ください。
https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/

では、serposcope.debパッケージをダウンロードして、.debを実行してください。

sudo dpkg -i serposcope.deb

これを実行すると、Serposcopeがインストールされます。
インストール完了後は、次のURLでSerposcopeの起動を確認します。
http://127.0.0.1:7134/

もし、SerposcopeがJAVA_HOMEを見つけられない場合は、/etc/default/serposcopeで定義してください。

Serposcopeは、OSが起動するたびに自動的に立ち上がります。
Serposcopeを起動、停止、再起動したい場合は次のコマンドを利用します。

sudo service serposcope start|stop|restart

SerposcopeのMac、CentOS、その他のUnixディストリビューションへのインストール手順

admin@localhost:~$ java -version
java version "1.8.0_66"

MACの場合は、Oracle JDK 1.8をダウンロードする必要があるかもしれません。
Serposcopeのjar版をダウンロードします。
https://serposcope.serphacker.com/en/#download

次に、コマンドラインを開き、java -jar serposcope.jarを実行します。
実行後は、次のURLでSerposcopeの起動を確認します。
http://127.0.0.1:7134/

自動インストーラー・起動時にSerposcopeを自動起動する方法はまだ提供していません。
しかし、それらの開発への貢献は歓迎します。

Serposcopeのデータディレクトリと重要なファイル

これらのディレクトリやファイルは、最初の実行時に自動的に作成されます。
これらのディレクトリやファイルのパスは、お使いのオペレーティングシステムによって異なります。

Windows

ほとんどの場合は、C:\ProgramData\serposcopeです。
そうでなければ、環境変数%ProgramData%の値を確認してください。

このフォルダには、すべてのログファイル、データベース db.mv.db、設定ファイル serposcope.conf が入っています。

Debian/Ubuntu

設定ファイル　/etc/serposcope.conf
ログ　/var/log/serposcope/
データディレクトリ　/var/lib/serposcope/

Mac、CentOS、その他のUnixディストリビューション

データディレクトリは、serposcopeディレクトリの出来上がります。
例えば、ユーザー「bob」がSerposcopeを起動した場合は、以下のどちらかとなります。

/Users/bob/serposcope
/home/bob/serposcope

フォルダの階層は、Windowsと同じです。

Serposcopeの高度な設定

Serposcopeの設定は、serposcope.confファイルを使って変更することができます。

Javaコマンド（Mac OSXとGeneric パッケージ）でSerposcopeを直接起動する場合は、 serposcope.confのパスを渡す必要があります。

java -Dserposcope.conf=/path/to/serposcope.conf -jar serposcope.jar

Windowsと.debパッケージでは、このパスはすでに指定されています。
データディレクトリのパスは、serposcope.confを確認してください。

警告: ほとんどの場合、このファイルを編集する必要はありません。Serposcopeは追加の設定をせず、難しい設定もなしですぐに動作します。

# path where is stored embedded database and data files
#serposcope.datadir=

# log path
#serposcope.logdir=

# alternative database url, mysql example to use mysql : 
# serposcope.db.url=jdbc:mysql://HOSTNAME/DATABASE?user=USER&amp;password=PASS&amp;allowMultiQueries=true
#serposcope.db.url=

# additional database options
#serposcope.db.options=
#serposcope.db.debug=

# listen interface
#serposcope.listenAddress=

# listen port
#serposcope.listenPort=