JPedal Dockerイメージの実行方法

JPedalの起動

JPedalにはidrsolutions/jpedalというDockerイメージが用意されており、簡単に使い始めることができます。このDockerイメージを使用すると、シンプルなREST APIを使用してJPedalで変換を実行できるコンテナを起動できます。

このイメージは、Dockerがインストールされているクラウドプラットフォームやサーバーから使用できます。独自のサーバー/インフラストラクチャでDockerイメージを使用する手順については、以下を参照してください。

WARファイルのダウンロードまたはビルド

開始する前に、WARファイルが必要です。これはダウンロードするか、自分でビルドすることができます。
このWARファイルは、JPedalサービスが動作するために必須です。

WARファイルのダウンロード

jpedal-microservice.war ファイルをダウンロードしてください。

トライアルユーザーの方は、トライアル登録後のDockerセクションでwarファイルのダウンロードリンクを見つけることができます。

WARファイルのビルド

JPedal Microservice Exampleプロジェクトのコピーをビルドしてください。
手順はGitHubページに記載されています。

Dockerのインストール

Dockerをインストールして使用できるようにする方法を説明したチュートリアルは数多くあります。このDockerのインストールチュートリアルで、必要なすべてがカバーされています。

Dockerの実行

 docker run -p 80:80 --mount "source=/path/to/war/jpedal-microservice.war,target=/usr/local/tomcat/webapps/ROOT.war,type=bind" idrsolutions/jpedal

[推奨] HTTPSの有効化

本番環境で使用する場合は、HTTPS暗号化を有効にすることを強く推奨します。コンテナは、/opt/ssl/ディレクトリにSSL証明書、秘密鍵、証明書チェーンが見つかった場合、HTTPSに切り替わるように事前設定されています。必要なのは、certificate.crt、private.key、ca_bundle.crtというファイルを含むディレクトリをマウントすることだけです。上記のコマンドに以下を追加してください：

 -p 443:443 --mount "source=/local/path/to/ssl/directory,target=/opt/ssl,type=bind,readonly"

[オプション] 認証情報の定義

サービスにユーザー名とパスワードを設定したい場合は、以下の環境変数を追加で提供することで実現できます：

 --env ACCESS_USERNAME=<username> --env ACCESS_PASSWORD=<password>

[上級者向け] 複数ユーザーの追加

複数のユーザーが必要な場合は、独自のtomcat-users.xmlファイルを用意し、/usr/local/tomcat/conf/tomcat-users.xmlにマウントすることができます。

[オプション] ボリュームのマウント

APIを使用せずにホストマシンから変換されたファイルにアクセスする必要がある場合は、出力場所にドライブをマウントする必要があります。

これは、docker runコマンドに以下を追加することで実現できます。

 --mount "source=/path/to/documents,target=/root/.idr,type=bind"

異なる言語のクライアントからJPedalを実行する

これでDockerサーバーが実行されているので、APIを使用して変換を開始するためのチュートリアルに従うことができます。