在 Mac 上托管
IronSecureDoc 是一個 Docker 容器,旨在為您提供強大的 PDF 操作,通過簡單的 REST API,而無需在線 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
Docker 桌面版 (適用於搭載 Intel 晶片的 Mac)](https://docs.docker.com/desktop/install/mac-install/) 安裝並運行
配備 Apple 矽晶片的 Mac
分步指南
1. 安裝 Docker Desktop
如果你還沒有安裝 Docker Desktop,請依照以下步驟進行:
下載適用於 Windows 的 Docker Desktop 安裝程式。
執行安裝程式並按照螢幕上的指示進行操作。
- 安裝完成後,啟動 Docker Desktop 並確保它正在運行。
2. 拉取 "IronSecureDoc" Docker 映像檔
打開命令提示字元,從 Docker Hub 拉取最新的 IronSecureDoc 映像檔:
docker pull ironsoftwareofficial/ironsecuredoc:latest
3. 無需證書運行容器
使用必要的環境變數運行 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>
替換為您實際的 IronSecureDoc 授權金鑰。否則,在企業功能上將會出現浮水印。4. 存取容器
當容器正在執行時,你可以打開網頁瀏覽器並導航至以下網址以存取 IronSecureDoc:
http://localhost:8080/swagger/index.html
請提供內容以進行翻譯。
您應該會看到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
:配置跨來源資源共享 (跨域資源共享 (CORS)) 通過指定允許的來源 URL。用逗號分隔多個 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'
將 /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]請使用您想要匹配和編輯的正則表達式。
結論
您已成功在您的機器上託管了 IronSecureDoc,並配置了必要的環境變量。您還學會了如何使用 cURL 與 IronSecureDoc REST API 進行基本和高級操作。如需進一步配置和使用詳細訊息,請參考完整的 REST API 參考文件.