在 Mac 上托管

查克尼思·賓

2024年7月20日

已更新 2024年10月28日

Translated

View the article in English

IronSecureDoc 在 Docker 上 IronSecureDoc 是一個 Docker 容器，旨在通過簡單的 REST API 提供強大的 PDF 操作功能，無需線上 SaaS 服務的麻煩和開銷。本指南將引導您完成在您的機器上部署IronSecureDoc的步驟，包括設置環境變量和使用REST API的基本示例。完整 API 請查看我們的REST API 參考文件

docker pull ironsoftwareofficial/ironsecuredoc:latest

先決條件

Docker 在最新版本的 macOS 上支援 Docker Desktop。即是指 macOS 的當前版本以及之前的兩個版本。隨著新版本的 macOS 正式發布，Docker 停止支援最舊版本，並支援最新版本的 macOS（以及前兩個版本）。

搭載 Intel 晶片的 Mac

Docker Desktop for Mac with Intel chip 已安裝並運行
搭載Apple Silicon的Mac
Docker Desktop for Mac with Apple silicon 已安裝並運行

分步指南

1. 安裝 Docker Desktop

如果您尚未安裝 Docker Desktop，請按照以下步驟操作：

前往Docker Desktop 下載頁面。
下載適用於 Windows 的 Docker Desktop 安裝程式。
運行安裝程式並按照屏幕上的指示操作。
安裝完成後，啟動 Docker Desktop 並確保其正在運行。

2. 拉取 "IronSecureDoc" Docker 映像

打開命令提示字元，並從 Docker Hub 拉取最新的 IronSecureDoc 映像檔：

docker pull ironsoftwareofficial/ironsecuredoc:latest

3. 無證書運行容器

在 Docker 容器中運行並設置必要的環境變數：

瀏覽器中的 Swagger UI

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

瀏覽器中的 Swagger UI

您應該會看到IronSecureDoc介面，這表示您的容器運行成功。

5. 運行帶有證書的 IronSecureDoc 容器

如果您需要使用憑證運行容器，請按照以下步驟生成憑證並配置本地機器：

生成證書：

  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:latest

將<IRONSECUREDOC_LICENSE_KEY>和<CERTIFICATE_PASSWORD>替換為您的實際IronSecureDoc授權密鑰和證書密碼。

6. 管理容器

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

停止容器：

  docker stop ironsecuredoc

啟動容器：

  docker start ironsecuredoc

移除容器：

  docker rm -f ironsecuredoc

環境變數

容器可以使用以下環境變數進行配置：

PDF_MAX_SIZE_MB（預設值：30）：設定上傳PDF的最大允許文件大小，單位為兆位元組（MB）。
REQUEST_TIMEOUT_SECONDS（預設為：5）：設定 API 請求的超時時間（以秒為單位）。值為 -1 表示請求可以無限期執行。
ALLOWED_ORIGINS：透過指定允許的來源 URL 來配置跨來源資源共享（CORS）。使用逗號分隔多個網址。使用 * 或 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'

將 /path/to/your/document.pdf 替換為您想要編輯的文件的實際路徑，將 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'

將/path/to/your/document.pdf替換為您要修訂的文件的實際路徑，並將[0-9]替換為您要匹配和修訂的正則表達式。