How to Host IronSecureDoc on Windows with C#
IronSecureDoc 是一个 Docker 容器，旨在通过简单的 REST API 为您提供强大的 PDF 操作功能，而无需在线 SaaS 服务的麻烦和开销。 本指南将引导您完成在计算机上托管 IronSecureDoc 的步骤，包括设置环境变量和使用 REST API 的基本示例。 如需查看完整的 API，请参阅我们的REST API 参考文档。
docker 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:latest3. 无需证书即可运行容器
使用必要的环境变量运行 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许可证密钥替换<IRONSECUREDOC_LICENSE_KEY>。 否则，企业功能将添加水印。
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用密码替换<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分别用您的实际IronSecureDoc许可证密钥和证书密码替换<CERTIFICATE_PASSWORD>。
6. 管理容器
您可以使用 Docker 命令管理正在运行的容器。 以下是一些常用命令：
-停止容器：
docker stop <container-id>-启动容器：
docker start <container-id>-移除容器：
docker rm -f <container-id>用实际的容器ID或名称替换<container-id>。
环境变量
可以使用以下环境变量配置容器：
PDF_MAX_SIZE_MB（默认：30）：设置PDF上传的最大允许文件大小，以兆字节为单位。REQUEST_TIMEOUT_SECONDS（默认：5）：设置API请求的超时时间，以秒为单位。 值为-1允许请求无限期运行。ALLOWED_ORIGINS：通过指定允许的来源URL来配置跨域资源共享（CORS）。 多个网址之间用逗号分隔。 使用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'用您要编辑的文档的实际路径替换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'用您要编辑的文档的实际路径替换[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 Desktop。
如何在我的 Windows 机器上安装 Docker Desktop？
从 Docker 的官方网站下载 Docker Desktop，运行安装程序，并按照安装说明进行操作。安装完成后，启动 Docker Desktop 以开始使用。
如何下载 IronSecureDoc Docker 映像？
打开您的命令提示符并执行命令：docker pull ironsoftwareofficial/ironsecuredoc:latest 以下载 IronSecureDoc 映像。
是否可以在没有 SSL 证书的情况下运行 IronSecureDoc？
是的，您可以通过执行命令来运行不带 SSL 证书的 IronSecureDoc 容器：docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest，将
容器运行后如何访问 IronSecureDoc 界面？
您可以打开网络浏览器并导航到 http://localhost:8080/swagger/index.html 来访问 IronSecureDoc 界面。
如何使用 SSL 证书配置 IronSecureDoc？
using 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/。
Curtis Chau 拥有卡尔顿大学的计算机科学学士学位，专注于前端开发，精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面，喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。
