1. IronSecureDoc
  2. 教程
  3. Azure 主机和设置

在 Linux 上托管

This article was translated from English: Does it need improvement?
Translated
View the article in English

Docker 上的 IronSecureDocIronSecureDoc 是一个 Docker 容器，旨在通过简单的 REST API 为您提供强大的 PDF 操作功能，而无需在线 SaaS 服务的麻烦和开销。本指南将指导你完成在机器上托管 IronSecureDoc 的步骤，包括设置环境变量和使用 REST API 的基本示例。有关完整的 API，请查看我们的 REST 应用程序接口参考

docker pull ironsoftwareofficial/ironsecuredoc:latest

先决条件

在继续之前

在 Linux 上运行 Docker Desktop 虚拟机 (虚拟机) 会在启动时创建并使用自定义的 docker 上下文 "desktop-linux"。

这意味着部署在 Linux Docker 引擎上的图像和容器 (安装前) 在 Linux 版 Docker Desktop 中不可用。

平台

分步指南

1.安装 Docker 桌面

如果尚未安装 Docker Desktop，请按照以下步骤操作：

1.前往 Docker Desktop 下载页面.

2.下载 Linux 版 Docker Desktop 安装程序。

3.运行安装程序，并按照屏幕上的说明操作。

4.安装完成后，启动 Docker Desktop 并确保其正在运行。

2.拉取 "IronSecureDoc "Docker 镜像

打开命令提示符，从 Docker Hub 提取最新的 IronSecureDoc 映像：

docker pull ironsoftwareofficial/ironsecuredoc:latest

3.不带证书运行容器

使用必要的环境变量运行 Docker 容器：

浏览器中的 Swagger UI

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 许可证密钥。否则，企业功能上将出现水印。

浏览器中的 Swagger UI

4.访问集装箱

容器运行后，您可以打开网络浏览器并导航至以下地址访问 IronSecureDoc：


http://localhost:8080/swagger/index.html

浏览器中的 Swagger UI您应该会看到 IronSecureDoc 界面，表明您的容器已成功运行。

5.使用证书运行 IronSecureDoc 容器

如果需要使用证书运行容器，请按照以下步骤生成证书并配置本地计算机：

  1. 生成证书：
   dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
   dotnet dev-certs https --trust

用密码替换 <CREDENTIAL_PLACEHOLDER>。

  1. 运行 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。用逗号分隔多个 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 应用程序接口参考.