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授權金鑰。 否則，企業功能將附加水印。

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

   <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'

將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'

將[0-9]替換為您想要匹配和編輯的正則表達式。

結論

您已成功在您的機器上託管 IronSecureDoc 並使用必要的環境變數進行了配置。 您還學會了如何使用 cURL 與 IronSecureDoc REST API 進行基本和高級操作。 如需進一步的配置和使用細節，請參考完整的 REST API 參考。