How to Host IronSecureDoc on Windows with C

IronSecureDoc 是一個 Docker 容器,旨在透過簡單的 REST API 提供強大的 PDF 操作功能,無需網上 SaaS 服務的麻煩和額外負擔。 本指南將引導您完成在您的機器上託管 IronSecureDoc 的步驟,包括設置環境變數和使用 REST API 的基本範例。 要查看完整的API,請參閱我們的REST API參考
docker pull ironsoftwareofficial/ironsecuredoc:latestdocker pull ironsoftwareofficial/ironsecuredoc:latest先決條件
- Windows作業系統
- Windows 10或更高版本
- Windows Server (2016, 2019, 2022) 注意:可能需要額外步驟
- 程式
逐步指南
1. 安裝 Docker Desktop
如果您尚未安裝Docker Desktop,請按照以下步驟進行:
- 前往 Docker Desktop 下載頁面。
- 下載適用於Windows的Docker Desktop安裝程式。
- 執行安裝程式並按照螢幕上的指示操作。
- 安裝完成後,啟動 Docker Desktop 並確保其正在運行。
2. 拉取" IronSecureDoc" Docker 映像
打開命令提示字元,從 Docker Hub 拉取最新的 IronSecureDoc 映像:
docker pull ironsoftwareofficial/ironsecuredoc:latestdocker pull ironsoftwareofficial/ironsecuredoc:latest3. 無證書運行容器
運行所需環境變數的 Docker 容器:

docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latestdocker 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 容器
如果您需要使用證書運行容器,請按照以下步驟生成證書並配置本地機器:
生成證書:
dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> dotnet dev-certs https --trustdotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> dotnet dev-certs https --trustSHELL用密碼替換
<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:latestdocker 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:latestSHELL分別用您的實際IronSecureDoc授權金鑰和證書密碼替換
<CERTIFICATE_PASSWORD>。
6. 管理容器
您可以使用 Docker 命令管理正在運行的容器。 以下是一些有用的命令:
停止容器:
docker stop <container-id>docker stop <container-id>SHELL啟動容器:
docker start <container-id>docker start <container-id>SHELL移除容器:
docker rm -f <container-id>docker rm -f <container-id>SHELL
用實際的容器ID或名稱替換<container-id>。
環境變數
可以使用以下環境變數配置容器:
PDF_MAX_SIZE_MB(預設值: 30):設定PDF上傳的最大允許檔案大小(以MB為單位)。REQUEST_TIMEOUT_SECONDS(預設值: 5):設定API請求的超時持續時間(以秒為單位)。 設定值為-1可允許請求無限期執行。ALLOWED_ORIGINS:透過指定允許的來源URL來配置跨來源資源共享(CORS)。 用逗號分隔多個 URL。 使用all允許來自任何來源的請求。HTTP_PORTS:定義容器暴露的HTTP端口。 這應該與使用8080)。 用分號分隔多個端口(;)。HTTPS_PORTS:定義容器暴露的HTTPS端口。 這應該與使用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'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。
修訂正則表達式
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'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 參考。
常見問題
什麼是IronSecureDoc?
IronSecureDoc是一個Docker容器,通過簡單的REST API提供強大的PDF操作,專為離線文件安全和合規設計。
在Windows上託管IronSecureDoc的系統要求是什麼?
要在Windows上託管IronSecureDoc,需要Windows 10或更高版本,或Windows Server版本(2016、2019、2022)以及安裝了Docker Desktop for Windows。
如何在我的Windows機器上安裝Docker Desktop?
從Docker官方網站下載Docker Desktop,運行安裝程式,並按照安裝說明進行。安裝完成後,啟動Docker Desktop以開始使用。
如何下載IronSecureDoc Docker映像?
打開您的命令提示符,執行命令:docker pull ironsoftwareofficial/ironsecuredoc:latest以下載IronSecureDoc映像。
能否在沒有SSL證書的情況下運行IronSecureDoc?
是的,您可以通過執行命令:docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=,將
容器運行後,我怎樣才能存取IronSecureDoc介面?
您可以通過打開網頁瀏覽器並導航至http://localhost:8080/swagger/index.html來存取IronSecureDoc介面。
如何配置帶有SSL證書的IronSecureDoc?
使用dotnet dev-certs生成證書,然後運行包含證書路徑和密碼的IronSecureDoc容器命令以增強安全性。
哪些環境變數可用於配置IronSecureDoc容器?
您可以配置各種環境變數,如PDF_MAX_SIZE_MB、REQUEST_TIMEOUT_SECONDS、ALLOWED_ORIGINS、HTTP_PORTS、HTTPS_PORTS和IronSecureDoc_LicenseKey。
如何使用IronSecureDoc在PDF中修正敏感資訊?
要修正PDF中的文字,請使用cURL命令向IronSecureDoc REST API發送POST請求,指定PDF文件以及需要修正的文字或模式。
在哪裡可以找到IronSecureDoc REST API的詳細文件?
IronSecureDoc的完整REST API參考可在/enterprise/securedoc/tutorials/use-rest-api/。





