How to Host IronSecureDoc on Windows with C#
IronSecureDoc は、オンライン SaaS サービスの手間やオーバーヘッドなしに、シンプルな REST API の背後で強力な PDF 操作を実現するように設計された Docker コンテナーです。 このガイドでは、環境変数の設定や REST API の基本的な使用例など、IronSecureDoc をマシン上でホストする手順について説明します。 完全なAPIについては、 REST APIリファレンスをご覧ください。
docker pull ironsoftwareofficial/ironsecuredoc:latest前提条件
- Windows オペレーティング システム
- Windows 10以降
- Windows Server (2016、2019、2022)注: 追加の手順が必要になる場合があります -プログラム
- Docker Desktop for Windowsがインストールされ、実行されている
ステップバイステップガイド
1. Dockerデスクトップをインストールする
Docker Desktop をまだインストールしていない場合は、次の手順に従ってください。
- Docker Desktop のダウンロード ページにアクセスします。
- Windows 用の Docker Desktop インストーラーをダウンロードします。
- インストーラーを実行し、画面の指示に従います。
- インストール後、Docker Desktop を起動し、実行されていることを確認します。
2. "IronSecureDoc"Dockerイメージをプルする
コマンドプロンプトを開き、Docker Hub から最新の IronSecureDoc イメージをプルします。
docker pull ironsoftwareofficial/ironsecuredoc:latest3. 証明書なしでコンテナを実行する
必要な環境変数を使用して Docker コンテナを実行します。
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest透かしを削除するには試用版またはライセンスキーを適用します
<IRONSECUREDOC_LICENSE_KEY>を置換してください。 それ以外の場合は、エンタープライズ機能に透かしが適用されます。
4. コンテナにアクセスする
コンテナが実行されると、Web ブラウザを開いて次の場所に移動し、IronSecureDoc にアクセスできます。
http://localhost:8080/swagger/index.html
コンテナが正常に実行されていることを示す IronSecureDoc インターフェースが表示されます。
5. 証明書を使用してIronSecureDocコンテナを実行する
証明書を使用してコンテナを実行する必要がある場合は、次の手順に従って証明書を生成し、ローカル マシンを構成します。
1.証明書を生成する:
dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust<CREDENTIAL_PLACEHOLDER>をパスワードと置換してください。
-
Dockerコンテナを実行します。
docker container run -d -p 8081:8081 -p 8080:8080 -e HTTP_PORTS=8080 -e HTTPS_PORTS=8081 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Production -v %USERPROFILE%\.aspnet\https:/https:ro -e CERTIFICATE_PATH=%USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> ironsoftwareofficial/ironsecuredoc:latestSHELL<CERTIFICATE_PASSWORD>をそれぞれ実際のIronSecureDocライセンスキーと証明書のパスワードに置換してください。
6. コンテナの管理
Docker コマンドを使用して実行中のコンテナを管理できます。 以下に、役立つコマンドをいくつか示します。
-コンテナを停止します:
docker stop <container-id>-
コンテナを開始する:
docker start <container-id>SHELL
-コンテナを削除します:
docker rm -f <container-id><container-id>を実際のコンテナIDまたは名前と置換してください。
環境変数
コンテナは次の環境変数を使用して構成できます。
PDF_MAX_SIZE_MB(デフォルト: 30): PDFアップロードの最大許可ファイルサイズをメガバイトで設定します。REQUEST_TIMEOUT_SECONDS(デフォルト: 5): APIリクエストのタイムアウト時間を秒で設定します。-1の値はリクエストが無期限に実行されることを許可します。ALLOWED_ORIGINS: 許可されるオリジンURLを指定することで、クロスオリジンリソース共有 (CORS) を構成します。 複数のURLはカンマで区切ってください。*またはallを使用して、任意のオリジンからのリクエストを許可します。HTTP_PORTS: コンテナが公開するHTTPポートを定義します。 これは-pフラグを使用したポートマッピング (例:8080) に一致する必要があります。 複数のポートをセミコロン (;) で区切ってください。HTTPS_PORTS: コンテナが公開するHTTPSポートを定義します。 これは-pフラグを使用したポートマッピング (例:8081) に一致する必要があります。 複数のポートをセミコロン (;) で区切ってください。IronSecureDoc_LicenseKey(必須): IronSecureDocライセンスキーを設定します。 重要: この値を公開しないでください。
基本的な例: ドキュメント内のテキストを編集する
API エンドポイントの完全なリストについては、完全なREST API リファレンスを参照してください。
テキストを編集
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' -H 'accept: */*' -H 'Content-Type: multipart/form-data' -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' -F 'words_to_redact="sensitiveWord"' -F 'draw_black_box=true' -F 'match_whole_word=true' -F 'match_case=true'sensitiveWordを編集したい単語と置換してください。
正規表現を編集する
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-regular-expression' -H 'accept: */*' -H 'Content-Type: multipart/form-data' -F 'pdf_file=@/path/to/your/document.pdf;type=application/pdf' -F 'regular_expression="[0-9]"' -F 'draw_black_box=true'[0-9]を一致させて編集したい正規表現と置換してください。
結論
マシン上で IronSecureDoc をホストし、必要な環境変数を設定しました。 cURLを使用して、基本および高度な操作の両方のためにIronSecureDoc REST APIと対話する方法を学びました。 さらなる構成と使用方法の詳細については、完全なREST API リファレンスを参照してください。
よくある質問
IronSecureDocとは？
IronSecureDocは、オフライン文書のセキュリティとコンプライアンスのために設計された、シンプルなREST APIを介して強力なPDF操作を提供するDockerコンテナです。
WindowsでIronSecureDocをホスティングするためのシステム要件は何ですか？
WindowsでIronSecureDocをホスティングするには、Windows 10以降、もしくはWindows Serverバージョン（2016、2019、2022）が必要であり、Windows用のDocker Desktopがインストールされている必要があります。
私のWindowsマシンにDocker Desktopをインストールするにはどうすればいいですか？
公式DockerウェブサイトからDocker Desktopをダウンロードし、インストーラーを実行してインストール手順に従います。インストール完了後、Docker Desktopを起動して使用を開始します。
IronSecureDoc Dockerイメージをどのようにダウンロードしますか？
コマンドプロンプトを開き、コマンド docker pull ironsoftwareofficial/ironsecuredoc:latest を実行してIronSecureDocイメージをダウンロードします。
SSL証明書なしでIronSecureDocを実行することは可能ですか？
はい、IronSecureDocコンテナをSSL証明書なしで実行することができます。docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latestというコマンドを実行し、
コンテナが実行中の場合、IronSecureDocインターフェースにアクセスするにはどうすればよいですか？
ウェブブラウザを開き、http://localhost:8080/swagger/index.htmlに移動してIronSecureDocインターフェースにアクセスできます。
SSL証明書を用いてIronSecureDocを設定するにはどうすればいいですか？
Generate a certificate using dotnet dev-certs and then run the IronSecureDoc container with the command that includes the certificate path and password for enhanced security.
IronSecureDocコンテナを構成するために使用可能な環境変数はどれですか？
PDF_MAX_SIZE_MB、REQUEST_TIMEOUT_SECONDS、ALLOWED_ORIGINS、HTTP_PORTS、HTTPS_PORTS、IronSecureDoc_LicenseKeyなど、さまざまな環境変数を設定できます。
IronSecureDocを使用してPDFの機密情報を墨消しするにはどうすればよいですか？
PDFでテキストを墨消しするには、cURLコマンドを使用してIronSecureDoc REST APIにPOSTリクエストを送り、PDFファイルと墨消しするテキストまたはパターンを指定します。
IronSecureDoc REST APIの詳細なドキュメントはどこで見つけられますか？
IronSecureDocの完全なREST APIリファレンスは、/enterprise/securedoc/tutorials/use-rest-api/で利用可能です。
Curtis Chauは、カールトン大学でコンピュータサイエンスの学士号を取得し、Node.js、TypeScript、JavaScript、およびReactに精通したフロントエンド開発を専門としています。直感的で美しいユーザーインターフェースを作成することに情熱を持ち、Curtisは現代のフレームワークを用いた開発や、構造の良い視覚的に魅力的なマニュアルの作成を楽しんでいます。
