このノートでは、Exploratory サーバー(オンプレ)をLinuxマシンにインストールする方法を説明します。
このドキュメントの中に出てくる<<version>>
は、ご使用になるExploratory サーバーのバージョン(例:5.5.4.2)に置き換えて下さい。
システム要件(Exploratory サーバー(オンプレ)のセクション)を満たすサーバーと、Linux OSをご用意ください。もし、OSの選択肢にUbuntuがある場合、Ubuntuを推奨します。
これらがまだインストールされていない場合は、以下のページを参考にしてインストールしてください。
現在、以下のOSとDockerのバージョンの組み合わせがサポートされています。
Ubuntu のバージョン | Docker バージョン20 | Docker バージョン24 |
---|---|---|
16.04 | サポートされてます | - |
18.04 | サポートされてます | - |
20.04 | サポートされてます | - |
22.04 | サポートされてます | サポートされてます |
インストールの際、インターネットへ接続できない場合はこちらのノートに従って、Docker、Docker Composeおよび、必要な外部Dockerイメージをインストールしてください。
なおインターネットへの接続がある場合は、外部Dockerイメージは自動的にインストールされるため、この手順は不要です。
Dockerをroot以外のユーザーで使用可能な状態にするため、以下のコマンドを実行してご使用になるOSユーザーにDocker daemonに接続する権限を付与してください。
sudo usermod -a -G docker $USER
このコマンドの詳細についてはこちらのページをご参照ください。
上記の操作のあとで、一旦ログアウトしてからログインして、設定を有効にしてください。
Exploratory サーバーを初めてインストールする際は、こちらのページより、お申し込みください。お申し込みをいただきましたら、弊社よりDockerイメージのダウンロードリンクを送付いたします。
exploratory-collab-<<version>>.tar.gz
- ダウンロードされる圧縮ファイル。この中に以下のファイルが入っています。exploratory-collab-images-<<version>>.tar.gz
- Dockerイメージ・ファイル圧縮ファイルのダウンロード後に、以下のコマンドを実行して圧縮ファイルを展開してください。これによってexploratoryディレクトリが作成されます。
$ tar xvfz exploratory-collab-<<version>>.tar.gz
以下のコマンドを実行して、Dockerイメージをロードしてください。
$ cd exploratory
$ docker load -i exploratory-collab-images-<<version>>.tar.gz
圧縮ファイルを展開してできた"exploratory"ディレクトリ直下にある設定ファイルexploratory_config.ymlをエディタで開いて、設定を書き換えます。
変更前の設定:
admin_email: you@yourcompany.com
server_port: 8080
license_key: 30daystrial
admin_emailは、管理者用emailアドレスです。元の値が“you@yourcompany.com”としてあるところを、Exploratory サーバーの管理者として使用するemailアドレスに置き換えてください。
server_portは、サーバーのポート番号です。デフォルトで8080となっていますが、必要であれば他の番号に置き換えてください。
license_keyには、Exploratoryより取得したライセンス・キーの文字列を指定してください。ライセンス・キーをお持ちでない場合はsupport@exploraotry.io
までお問い合わせください。
**注意:**exploratory_config.ymlファイルは、インストール時のみに利用される簡易設定ファイルです。インストールが終わった後には、exploratory_config.ymlファイルへの変更は無視されます。インストール後の設定変更では、この後で生成されるdocker-compose.ymlファイルを変更することになります。
圧縮ファイルを展開してできた"exploratory"ディレクトリ直下にある、"configure.sh"ファイルを実行します。以下のコマンドを実行してください。
$ ./configure.sh
以下のコマンドを実行してExploratory サーバーを起動してください。
$ docker-compose up -d
サーバの起動時に問題がある場合、よくあるExploratoryサーバーの問題と解決法の「Exploratoryサーバーを起動するときのエラー」をご参照ください。
起動が完了したら、ブラウザに、Exploratory サーバーのURLをタイプするとトップページが以下のように表示されます。URLは以下のような書式となります。
<host名>:<port番号>
画面右上の“ログイン”のリンクをクリックします。
exploratory_config.ymlに設定した、管理者用emailアドレスでログインします。デフォルトのパスワードは‘welcome1’です。
ログイン後に、“管理”のリンクをクリックすると、以下のように管理者用の画面が表示されます。
管理画面で、“ユーザー”のメニューをクリックします。
ユーザーの表が表示されます。ここで、“新しいユーザーを作成”ボタンをクリックします。
新規に作成するユーザーに関する、以下の情報を入力して、“作成”ボタンをクリックします。
"新しいユーザーの作成"ダイアログが表示されます。
このとき、以下の条件に当てはまるブラウザを利用した場合、"新しいユーザーの作成"ダイアログが正しく表示されないことがあります。(Exploratory サーバーでサポートされているブラウザにつきましてはこちらよりご確認ください)
"メールアプリケーションを開く"ボタンをクリックするとご使用のメーラー上に、招待するユーザーにアクティベーションURLを送付するためのメールが準備されます。
Exploratory サーバーをインストールしているマシンにメールサーバーがない場合や、直接管理者の方がアクティベートをしたい場合はダイアログ内のアクティベーションURLをブラウザに直接貼り付けることで、その場でアクティベートすることができます。
アクティベーションURLの入ったEmailを受け取ったユーザーは、そのURLをクリックすることでアカウントをアクティベートすることができます。
その際にユーザーは、以下の情報を入力する必要があります。
アカウントがアクティベートされると、ユーザーはExploratory デスクトップのダウンロードページにリダイレクトされ、そこからExploratory デスクトップをダウンロード、インストールして使用し始めることができます。(すでにExploratory デスクトップの最新版をインストールされているユーザーはそのまま次のステップに移って下さい。)
Exploratory デスクトップをダウンロードしたユーザーは、この後で説明するステップを経て、Exploratory デスクトップをExploratory サーバーに接続して使用できます。
ユーザーの種類がAuthorであっても、Viewerであっても、コラボレーション・サーバーのユーザーは管理者として設定することが可能です。
ユーザーを管理者に変更するには、ユーザー管理画面から、編集ボタンをクリックします。
続いて管理者ユーザーにチェックをつけ、更新ボタンをクリックします。
「変更が保存されました。」というメッセージが表示されたら成功です。
もし既にExploratory デスクトップをインストールしてご使用されている場合、そのまま接続するサーバーだけをExploratoryサーバーに切り替えることができます。
Exploratory デスクトップを起動して、プロジェクト・リストのページの右上隅の三角形のアイコンをクリックすると現れる、"サインアウト"メニューを選択します。
サーバータイプに‘コラボレーション・サーバー’を選択し、Exploratory サーバーのURLを入力します。
Eメールアドレスとパスワードを入力し、“ログイン”ボタンをクリックします。
新しくExploratory デスクトップをインストールして使い始める場合、Exploratory デスクトップは、デフォルトでexploratory.ioに接続しようとします。
ここで、exploratory.ioではなくExploratory サーバーに接続するには、以下の設定が必要となります。この設定は、インストール時に一度だけ行うものです。
Exploratory デスクトップを初めて起動するときに表示されるサイン・イン画面でサーバータイプに‘コラボレーション・サーバー’を選択し、Exploratory サーバーのURLを入力します。
この後、'ログイン'ボタンをクリックして、その後は画面の指示に従ってインストールを進めてください。
Exploratory サーバーの管理者(Admin User)はユーザーがスケジュールしたジョブを一時保留(Deque)したり、削除(Delete)したりすることができます。
詳細についてはExploratory サーバーのスケジュールを管理する方法をご覧ください。
SSL(HTTPS)を使った接続の設定方法については、こちらのノートをご覧ください。
インサイトが共有された際に、共有されたユーザーに知らせるためにemailが送信されるように設定することができます。そのためには、こちらのノートに従ってemail送信サーバー(SMTPサーバー)への接続情報を設定してください。
指定したIPアドレスからのみ管理ページにアクセスが可能なように設定が可能です。詳しくはこちらをご覧ください。
定期的に、exploratory
フォルダ以下の全てのファイルのバックアップを取ることをおすすめします。
バックアップからExploratory サーバーを復元する手順は、以下のとおりです。
exploratory
フォルダを復元して下さい。OAuthを利用して、Google Drive、Google Cloud Storage、Google Sheets、Google Analytics、Google BigQueryに接続するための設定については、こちらのノートをご覧ください。
OAuthを利用して、Salesforceに接続するための設定については、こちらのノートをご覧ください。
現在サポートされている、データソースのタイプについては、 こちらのノートをご覧ください。
適切なメモリの割り当てをすることで、Exploratoryサーバーのパフォーマンスを改善することができます。詳しくはこちらのガイドをご覧ください。
以下のコマンドを実行することで、サーバーで利用されているDockerコンテナの現在のメモリ使用率、CPU使用率などの統計情報を表示することができます。
docker stats
統計情報を継続的に収集したい場合は、--no-stream
オプションをつけて出力頻度を1回にしたものを cron コマンド等で定期実行し、その出力を保存します。
docker stats --no-stream
こちらのトラブルシューティング・ガイドに、よくある問題と、その解決策がまとめてあります。