如何使用 C# 在 Windows 上託管 IronSecureDoc

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)注意: 可能需要額外的步驟 -程式
- 已安裝並執行適用於 Windows 的 Docker Desktop
逐步指南
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使用試用金鑰或許可證金鑰去除浮水印
[{t:(替換<IRONSECUREDOC_LICENSE_KEY>使用您實際的 IronSecureDoc 授權金鑰。 否則,企業功能將會新增浮水印。

4. 訪問容器
容器運行後,您可以透過開啟網頁瀏覽器並導航至以下位址來存取 IronSecureDoc:
http://localhost:8080/swagger/index.html
您應該會看到 IronSecureDoc 介面,這表示您的容器正在成功運行。
5. 使用憑證執行 IronSecureDoc 容器
如果需要使用憑證執行容器,請依照下列步驟產生憑證並設定本機:
1.生成證書:
dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust代替<CREDENTIAL_PLACEHOLDER>使用密碼。
2.運行 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 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 <container-id> docker stop <container-id>-啟動容器:
docker start <container-id> docker start <container-id>-移除容器:
docker rm -f <container-id> docker rm -f <container-id>代替<container-id>使用實際的容器 ID 或名稱。
環境變數
可以使用以下環境變數配置容器:
PDF_MAX_SIZE_MB(預設值:30):設定 PDF 上傳允許的最大檔案大小(以兆位元組為單位)。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'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'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 參考文件。
常見問題解答
什麼是 IronSecureDoc?
IronSecureDoc 是一個 Docker 容器,通過簡單的 REST API 提供強大的 PDF 操作,專為離線文檔安全和合規性而設計。
在 Windows 上託管 IronSecureDoc 的系統要求是什麼?
要在 Windows 上託管 IronSecureDoc,您需要 Windows 10 或更高版本,或者 Windows Server 版本(2016、2019、2022)和已安裝的適用於 Windows 的 Docker 桌面。
如何在我的 Windows 計算機上安裝 Docker 桌面?
從官方 Docker 網站下載 Docker 桌面,運行安裝程序並遵循安裝說明。安裝完成後,啟動 Docker 桌面開始使用。
如何下載 IronSecureDoc Docker 映像?
打開命令提示符並執行命令:docker pull ironsoftwareofficial/ironsecuredoc:latest 以下載 IronSecureDoc 映像。
可以在沒有 SSL 證書的情況下運行 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 命令將 POST 請求發送到 IronSecureDoc REST API,指定 PDF 文件和要遮蔽的文本或模式。
在哪裡可以找到 IronSecureDoc REST API 的詳細文檔?
IronSecureDoc 的完整 REST API 參考文檔位於 /enterprise/securedoc/tutorials/use-rest-api/。





