在 Windows 上托管
IronSecureDoc 是一个 Docker 容器，旨在通过一个简单的 REST API 提供强大的 PDF 操作功能，无需在线 SaaS 服务的繁琐和开销。 本指南将指导您完成在您的机器上托管IronSecureDoc的步骤，包括设置环境变量和使用REST API的基本示例。 要查看完整的 API，请查阅我们的REST 应用程序接口参考
docker pull ironsoftwareofficial/ironsecuredoc:latest先决条件
- Windows操作系统
- Windows 10或更高版本
- Windows Server(2016, 2019, 2022) 请注意：可能需要额外步骤
- 程序
- 适用于 Windows 的 Docker 桌面安装并运行
分步指南
1. 安装 Docker Desktop
如果您尚未安装Docker Desktop，请按照以下步骤操作：
下载 Windows 版 Docker Desktop 安装程序。
运行安装程序并按照屏幕上的指示操作。
- 安装后，启动Docker桌面版并确保其正在运行。
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_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上传的最大允许文件大小（以兆字节为单位）。
请求超时秒数(默认值：5)设置 API 请求的超时时长（秒）。 值为-1表示请求可以无限期运行。ALLOWED_ORIGINS：配置跨源资源共享(CORS)通过指定允许的来源 URL。 用逗号分隔多个网址。 使用 * 或 all 来允许来自任何源的请求。HTTP_PORTS：定义容器公开的HTTP端口。 这应该与使用-p标志的端口映射相匹配。(例如，8080). 用分号分隔多个端口(;).HTTPS_PORTS：定义容器公开的HTTPS端口。 这应该与使用-p标志的端口映射相匹配。(例如，8081). 用分号分隔多个端口(;).IronSecureDoc_LicenseKey(需要)设置 IronSecureDoc 许可证密钥。 重要提示：请勿公开分享此值。
基本示例：在文档中编辑文本
有关API端点的完整列表，请参考完整REST 应用程序接口参考.
编辑文本
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 替换为要编辑的文档的实际路径，并将 /path/to/your/document.pdf 替换为要编辑的文档的实际路径。[0-9]与要匹配和删节的正则表达式匹配。
结论
您已成功在您的机器上托管IronSecureDoc，并配置了必要的环境变量。 您还学习了如何使用cURL与IronSecureDoc REST API进行基本和高级操作的交互。 有关更多配置和使用细节，请参考完整的REST 应用程序接口参考.
