C# API を使用して Mac で IronSecureDoc をホストする

IronSecureDoc は、オンライン SaaS サービスの手間やオーバーヘッドなしに、シンプルな REST API の背後で強力な PDF 操作を実現するように設計された Docker コンテナーです。 このガイドでは、環境変数の設定や REST API の基本的な使用例など、IronSecureDoc をマシン上でホストする手順について説明します。 完全な API については、 REST API リファレンスをご覧ください。
# Pull the latest IronSecureDoc Docker image
docker pull ironsoftwareofficial/ironsecuredoc:latest# Pull the latest IronSecureDoc Docker image
docker pull ironsoftwareofficial/ironsecuredoc:latest前提条件
Intelチップ搭載Mac
Apple Silicon搭載Mac
ステップバイステップガイド
1. Dockerデスクトップをインストールする
Docker Desktop をまだインストールしていない場合は、次の手順に従ってください。
- Docker Desktop のダウンロード ページにアクセスします。
- Mac用のDocker Desktopインストーラをダウンロードします。
- インストーラーを実行し、画面の指示に従います。
- インストール後、Docker Desktop を起動し、実行されていることを確認します。
2. "IronSecureDoc"Dockerイメージをプルする
コマンドライン インターフェイスを開き、Docker Hub から最新の IronSecureDoc イメージをプルします。
# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest3. 証明書なしでコンテナを実行する
必要な環境変数を使用して Docker コンテナを実行します。
# Run the Docker container with environment variables
docker container run --rm -p 8080:8080 \
-e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> \
-e ENVIRONMENT=Development \
-e HTTP_PORTS=8080 \
ironsoftwareofficial/ironsecuredoc:latest# Run the Docker container with environment variables
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>実際の IronSecureDoc ライセンス キーを入力します。 それ以外の場合、エンタープライズ機能に透かしが適用されます。
4. コンテナにアクセスする
コンテナが実行されると、Web ブラウザを開いて次の場所に移動し、IronSecureDoc にアクセスできます。
http://localhost:8080/swagger/index.htmlコンテナが正常に実行されていることを示す IronSecureDoc インターフェースが表示されます。
5. 証明書を使用してIronSecureDocコンテナを実行する
証明書を使用してコンテナを実行する必要がある場合は、次の手順に従って証明書を生成し、ローカル マシンを構成します。
1.証明書を生成する:
# Generate and trust HTTPS development certificate
dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust # Generate and trust HTTPS development certificate
dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust<CREDENTIAL_PLACEHOLDER>をパスワードに置き換えます。
Dockerコンテナを実行します。
# Run the container with HTTPS support 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 $HOME/.aspnet/https:/https:ro \ -e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \ -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \ ironsoftwareofficial/ironsecuredoc:latest# Run the container with HTTPS support 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 $HOME/.aspnet/https:/https:ro \ -e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \ -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \ ironsoftwareofficial/ironsecuredoc:latestSHELLヒント置換<IRONSECUREDOC_LICENSE_KEY>そして<CERTIFICATE_PASSWORD>実際の IronSecureDoc ライセンス キーと証明書のパスワードをそれぞれ入力します。
6. コンテナの管理
Docker コマンドを使用して実行中のコンテナを管理できます。 以下に、役立つコマンドをいくつか示します。
-コンテナを停止します:
docker stop <container_id_or_name> docker stop <container_id_or_name>コンテナを開始する:
docker start <container_id_or_name>docker start <container_id_or_name>SHELL
-コンテナを削除します:
docker rm -f <container_id_or_name> docker rm -f <container_id_or_name>環境変数
コンテナは次の環境変数を使用して構成できます。
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 リファレンスを参照してください。
テキストを編集
# Redact specific words in a PDF document
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'# Redact specific words in a PDF document
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'/path/to/your/document.pdf編集するドキュメントへの実際のパスに置き換え、 sensitiveWord編集する単語に置き換えます。
正規表現を編集する
# Redact text based on a regular expression in a PDF document
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'# Redact text based on a regular expression in a PDF document
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'/path/to/your/document.pdf 、編集するドキュメントへの実際のパスに置き換え、 [0-9]を、一致させて編集する正規表現に置き換えます。
結論
マシン上で IronSecureDoc をホストし、必要な環境変数を設定しました。 また、基本操作と高度な操作の両方で cURL を使用して IronSecureDoc REST API と対話する方法も学習しました。 さらなる構成と使用方法の詳細については、完全なREST API リファレンスを参照してください。
よくある質問
macOS 上で IronSecureDoc コンテナをホストするために必要な手順は何ですか?
macOSでIronSecureDocコンテナをホストするには、Docker Desktopをインストールし、最新のIronSecureDoc Dockerイメージをプルし、IronSecureDoc_LicenseKey, PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS などの環境変数でコンテナを構成する必要があります。詳細な手順はチュートリアルで提供されています。
MacでIronSecureDocコンテナをHTTPSサポートでどのように実行できますか?
MacでHTTPS付きのIronSecureDocコンテナを実行するには、dotnet dev-certsで証明書を生成し、-v for volumeと -e for environment variables を含む適切なコマンドで、証明書のパスとパスワードを指定してコンテナを実行します。
macOSでDockerコンテナが実行されている場合、IronSecureDocインターフェースにどのようにアクセスしますか?
macOSでDockerコンテナを実行すると、ウェブブラウザで http://localhost:8080/swagger/index.html にアクセスしてIronSecureDocインターフェースを利用できます。
macOSにDocker Desktopをインストールするための前提条件は何ですか?
macOSにDocker Desktopをインストールするには、MacがサポートされているmacOSのバージョン、現在のリリースおよび前の2つのリリースを実行していることを確認してください。また、IntelまたはApple Siliconのプロセッサーに適合するインストーラーを選択してください。
IronSecureDoc Dockerコンテナを使ってPDF内の単語やパターンをどのように編集できますか?
cURLなどのツールを使用し、IronSecureDoc APIエンドポイントにPOSTリクエストを送信し、編集するPDFファイルと編集する単語やパターンを指定することにより、PDF内の単語やパターンを編集できます。
macOS上のIronSecureDocコンテナで設定できる環境変数は何ですか?
IronSecureDocコンテナの環境変数には PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS, IronSecureDoc_LicenseKey があります。
macOS で最新の IronSecureDoc Docker イメージを取得するにはどうすればよいですか?
macOSで最新のIronSecureDoc Dockerイメージをプルするには、ターミナルで次のコマンドを実行します: docker pull ironsoftwareofficial/ironsecuredoc:latest。
Mac上でIronSecureDocコンテナを管理するための基本的なDockerコマンドは何ですか?
IronSecureDocコンテナを管理するための基本的なDockerコマンドには、docker stop, docker start, docker rm -f があります。





