Host IronSecureDoc on Mac with C# API

1. 安裝 Docker Desktop

若您尚未安裝 Docker Desktop，請依照以下步驟操作：

1. 前往 Docker Desktop 下載頁面。
2. 下載適用於 Mac 的 Docker Desktop 安裝程式。
3. 執行安裝程式並依照螢幕上的指示操作。
4. 安裝完成後，啟動 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:latest

3. 無需憑證即可執行容器

請設定必要的環境變數後執行 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 授權金鑰。 否則，"Enterprise版功能"將被加上浮水印。

4. 存取容器

容器啟動後，您可開啟網頁瀏覽器並導航至以下網址，以存取 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

   SHELL

   請將 <CREDENTIAL_PLACEHOLDER> 替換為密碼。

2. 執行 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:latest

   SHELL
   提示請分別將 <IRONSECUREDOC_LICENSE_KEY> 和 <CERTIFICATE_PASSWORD> 替換為您的實際 IronSecureDoc 授權金鑰和憑證密碼。

6. 容器管理

您可以使用 Docker 指令管理正在運行的容器。 以下是一些實用的指令：

• 停止容器：

  docker stop <container_id_or_name>

  docker stop <container_id_or_name>

  SHELL

• 啟動容器：

  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>

  SHELL

隱去文字

# 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 參考文件。