この章ではCopper PDFのセットアップ(インストール)方法について説明します。
Copper PDFをインストールするためには、Java実行環境(JREまたはJDK)が必要です。 Java実行環境は、各OSベンダが配布しているものをインストールするか、 https://www.oracle.com/technetwork/java/javase/downloads/index.html (Download JDK へ進んでください) で配布されているものをインストールしてください。
必要なJava実行環境はバージョン1.8.0以降の国際化対応Java実行環境です。 Java RE(JRE), Java SE(JDK…開発環境およびサーバー用Java VMを含むもの)の両方で動作しますが、 Java SEを推奨します。
LinuxではOpenJDKを始めとする様々なJava実行環境に対応しています。 WindowsではCopper PDF 3.2.7以降からOracle OpenJDKに対応していますがAdoptOpenJDKバンドル版を使用するか、あるいは次の説明の通り、 所定の位置にJava実行環境を配置することで様々なJava実行環境に対応することができます。
AdoptOpenJDKバンドル版を使用する場合はJDKのインストールは不要です。 AdoptOpenJDKバンドル版は64ビットOSのみに対応しています。
バンドルされたJava実行環境は、Windowsでは extras/windows/runtime 、Linuxでは extras/redhat/runtime に配置されています (rpm/deb パッケージ版では /var/lib/copper-pdf/extras/redhat/runtime)。 非バンドル版でも、その場所に他のJava実行環境を配置するか、ディレクトリをリンクすることにより、そのJava実行環境が優先して使用されます。 ただし、環境変数 JAVA_HOME が設定されている場合は、そちらが優先されます。
Copper PDF本体は、以下のパッケージが配布されています。 利用する環境に合ったパッケージをダウンロードしてください。 (3.x.xの部分はCopper PDFのバージョンにより異なります)
https://copper-pdf.com/?p=90 で配布されているZIPアーカイブ copper-pdf-3_x_x.zip または copper-pdf-3_x_x-openjdk-bundle-x64-windows.zip をダウンロードしてください。
各アーカイブを展開し、CopperPDFディレクトリを適当な場所に配置してください。 アンイストールはCopperPDFディレクトリを削除するだけです
[174 javajni.c] [error] 指定されたモジュールが見つかりません。この場合jdk1.6.0_x/binディレクトリ内のmsvcr71.dllをWindowsのsystem32ディレクトリにコピーすることで起動するようになります。
この方法では、CopperPDFディレクトリまでのファイルパスに半角英数字以外の文字(かな、漢字など) が含まれている場合と、Cドライブ以外にある場合はサービスの起動ができません。 Cドライブ直下、あるいはC:\Program Filesなど、半角英数字の文字だけで構成されるファイルパスに格納してください。
あるいは、後述するJava Service Wrapperの使用を推奨します。
アクセサリの「コマンドプロンプト」を管理者で実行し、 Copper PDFのディレクトリに移動してからInstallService.bat(x64版JavaVMの場合はRemoveService-x64.bat)を実行してください。 サービスを削除する場合も同様にRemoveService.bat(x64版JavaVMの場合はInstallService-x64.bat)を実行してください。
C:\>cd [Copper PDFのインストールディレクトリ] C:\[Copper PDFのインストールディレクトリ]>.\InstallService.bat
C:\>cd [Copper PDFのインストールディレクトリ] C:\[Copper PDFのインストールディレクトリ]>.\InstallService-x64.bat
Copper PDFは、Java Service Wrapper によるサービスとしてインストールすることができます。 Java Service Wrapperの全ての機能を利用し、開発元のタヌキソフトウェア有限会社によるサポートを受けるためには、別途ライセンスの購入が必要です。 Java Service Wrapperを使用することにより、障害発生時の自動復旧等が可能になり、より安定して運用することができます。
Copper PDFをJava Service Wrapperで動作させるためには、Java Service Wrapperの配布物に含まれる内容を、次の通りコピーしてください。
Java Service Wrapperの設定ファイルは、Copper PDFにconf/wrapper.confという名前で既に含まれています。 Java Service Wrapperのライセンスを購入した場合は、このファイルにライセンスキーの内容を追記してください。
サービスをインストールする場合は、InstallCopperPDF-NT.batを実行してください。 逆に、アンインストールする場合は、UninstallCopperPDF-NT.batを実行してください。 Windows Vistaでは、必ず管理者として実行してください。 サービスの起動と停止は、コントロールパネルの管理ツールから行ってください。
サービスはコントロールパネルの管理ツールから起動・停止することができます。
またcopperd.exeの-statusオプションによりサービスの状態を確認することができます。
C:\>cd [Copper PDFのインストールディレクトリ] C:\[Copper PDFのインストールディレクトリ]>copperd.exe -status * Status Report * [Summary] Uptime:0 days 0 h 0 min 3 s AccessCount:0 [Threads] Total:10 Busy:0 Free:10 Max:50 [Memory] Total:127.06MB Using:3.96MB Free:123.1MB Max:1016.13MB
RHEL(またはCentOS)向けにはRPMパッケージを配布しています。
copper-pdf-3.x.x-0.noarch.rpmをrpmコマンドでインストールしてください。 アンインストールの方法は通常のRPMパッケージの場合と同じです。
# sudo rpm -ivh copper-pdf-3.x.x-0.noarch.rpm
# sudo rpm -e copper-pdf
RHELではchkconfigおよびserviceコマンドでCopper PDFサーバーを管理できます。 Copper PDFサーバーのサービス名はcopperdです。 インストール直後は、Copper PDFサーバーの自動起動は無効化されています。
# sudo service copperd start
# sudo copperd -status
# sudo service copperd stop
# sudo service copperd restart
# sudo chkconfig copperd on
# sudo chkconfig copperd off
Debian/Ubuntu向けにはdebパッケージを配布しています。
export JAVA_HOME=/usr/local/jdk1.8.0_162
copper-pdf_3.x.x_all.debをdpkgコマンドでインストールしてください。 アンインストールの方法は通常のdebパッケージの場合と同じです。
# sudo dpkg -i copper-pdf_3.x.x_all.deb
# sudo dpkg -r copper-pdf
Debian/UbuntuではCopper PDFのサービスは/etc/init.d/copperdとして配置されます。 インストール直後は、Copper PDFサーバーの自動起動は無効化された状態です。 サービスの管理方法は以下の通り、通常のDebian/Ubuntuの手法に従います。
# sudo /etc/init.d/copperd start
# sudo copperd -status
# sudo /etc/init.d/copperd stop
# sudo /etc/init.d/copperd restart
# sudo update-rc.d /etc/init.d/copperd defaults
# sudo update-rc.d /etc/init.d/copperd remove
Java実行環境が必要です。pkg install openjdkコマンドにより、Java実行環境をインストールしてください。
copper-pdf-3.x.x.tar.gzを/optディレクトリに展開してください。 次に、展開してできたcopper-pdf-3.x.xディレクトリを、copper-pdfという名前に変更してください。
copper-pdfディレクトリ内のextras/freebsd/copperdに起動スクリプトの例があります。 これを/usr/local/etc/rc.d/copperdにコピーしchmod 555 /usr/local/etc/rc.d/copperdコマンドにより、実行権限を付与してください。
Java実行環境がopenjdk7の場合は、これでセットアップは完了です。 他のJava実行環境を使う場合は、/usr/local/etc/rc.d/copperd.shを編集し、 export JAVA_HOME=/usr/local/openjdk8 の部分を実際のJava実行環境の場所に設定してください。
Copper PDFサーバー起動と停止は、serviceコマンドにより行うことができます。
# service copperd start
# service copperd stop
その他の環境では、tar.gzアーカイブを使用してください。
copper-pdf-3.x.x.tar.gzを適当なディレクトリに展開してください。
LinuxあるいはUNIX系のOSの場合、展開してできたディレクトリ内のシェルスクリプト (copper, copperd, copper-webapp)を使用してください。 また、デーモンをセットアップするにはextras/redhat/copperdを編集し、 16行目でCOPPER_HOME環境変数にCopperPDFの配置ディレクトリを設定するようにし、適切な場所に配置してください。
COPPER_HOME=[CopperPDFの配置ディレクトリ]
Copper PDFに付属のシェルスクリプトは、環境変数JAVA_HOMEにより、Javaのインストールディレクトリを判別します。 /etc/profile等で、JAVA_HOMEを適切に設定してください。
export JAVA_HOME=/usr/local/jdk1.8.0_162
JAVA_HOMEが設定されていない場合、PATHに加えられているjavaコマンドが実行されます。
各ツールの実行方法の詳細はCopper PDFのツールの解説を参照してください。
アンインストールは、単にCopperPDFディレクトリを削除するだけです。
ZIPまたはtar.gzアーカイブを展開すると、copper-pdf-3_x_xというディレクトリができます。 各ツールの実行ファイルは、このディレクトリの直下にあります。 その他のディレクトリ構成は次の通りです。
copper-pdf-3_x_x |-- conf 設定ディレクトリ | `-- profiles プロファイル | `-- fonts フォント設定 |-- docs ドキュメント |-- extras アイコン、各プラットフォーム向けのファイル等 |-- legal 付属ライブラリのライセンス文書 |-- jetty サーブレットコンテナ(copper-webapp用) |-- lib ライブラリ |-- plugins プラグイン2.1.0 |-- logs ログディレクトリ `-- webapp copper-webapp
RPMまたはDebianパッケージでインストールした場合は、 Copper PDFの各コマンドラインツールは/usr/binと/usr/sbinに配置されます。
また、他のディレクトリの配置場所は次のとおりです。
ディレクトリ | 配置場所 |
---|---|
lib | /usr/share/copper-pdf/lib |
plugins2.1.0 | /usr/share/copper-pdf/plugins |
docs | /usr/share/doc/copper-pdf |
conf | /etc/copper-pdf (/var/lib/copper-pdf/confにシンボリックリンク) ※Copper PDF 2.0系以前では実ファイルとシンボリックリンクが逆転しています。 |
jetty | /var/lib/copper-pdf/jetty |
webapp | /var/lib/copper-pdf/webapp |
logs | /var/log/copper-pdf (/var/lib/copper-pdf/logsにシンボリックリンク) |
/etc/init.d/copperdはcopperユーザーで実行されます。 ファイルの読み書きが行われる /usr/share/copper-pdf/conf/profiles, /var/log/copper-pdf の各ディレクトリはcopperユーザーの所有となります。
Copper PDFは、そのままでは機能限定版として動作します。
Copper PDFを使用するためには、ライセンスキー・ファイルをlicense-keyという名前でconfディレクトリに配置する必要があります。 ライセンスキーはhttps://copper-pdf.com/?p=27で購入してください。
全ての機能を試用する場合は、 https://copper-pdf.com/?p=155 で試用ライセンスキーを取得してください。
confディレクトリ内の各種設定は、上位互換です。 過去のバージョンの設定は、新しいバージョンで常に動作します。
RPMパッケージまたはdebパッケージは、それぞれ通常の方法でアップデートしてください。
# sudo rpm -Uvh copper-pdf-3.x.x-0.noarch.rpm
# sudo dpkg -i copper-pdf_3.x.x_all.deb
その他(Windows, .zip, .tar.gzアーカイブ)の場合は、先にconfディレクトリをバックアップし、 Copper PDFを再インストールし、confディレクトリをアップデート前のものと置き換えてください。