在 Mac 上托管

查克尼特·宾
查克尼特·宾
2024年七月20日
更新 2024年十月28日
分享:
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 API 参考

docker pull ironsoftwareofficial/ironsecuredoc:latest

先决条件

Docker 支持最新版本 macOS 上的 Docker Desktop。 即是指macOS当前版本及之前的两个版本。 随着新的主要版本的macOS普遍可用,Docker停止支持最旧版本,并支持最新版本的macOS(以及之前的两个版本)。

搭载英特尔芯片的Mac

分步指南

1. 安装 Docker Desktop

如果您尚未安装Docker Desktop,请按照以下步骤操作:

  1. 请访问 Docker Desktop 下载页面

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

  3. 运行安装程序并按照屏幕上的指示操作。

  4. 安装后,启动Docker桌面版并确保其正在运行。

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上传的最大允许文件大小(以兆字节为单位)。
  • 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'

/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替换为您要编辑的文档的实际路径,并将[0-9]替换为您希望匹配和编辑的正则表达式。

结论

您已成功在您的机器上托管IronSecureDoc,并配置了必要的环境变量。 您还学习了如何使用cURL与IronSecureDoc REST API进行基本和高级操作的交互。 有关进一步的配置和使用详情,请参阅完整的REST API 参考指南

查克尼特·宾
软件工程师
Chaknith 负责 IronXL 和 IronBarcode 的工作。他在 C# 和 .NET 方面拥有深厚的专业知识,帮助改进软件并支持客户。他从用户互动中获得的洞察力,有助于提升产品、文档和整体体验。