使用 C# API 在 Mac 上托管 IronSecureDoc
IronSecureDoc 是一个 Docker 容器,旨在通过简单的 REST API 为您提供强大的 PDF 操作功能,而无需在线 SaaS 服务的麻烦和开销。 本指南将引导您完成在计算机上托管 IronSecureDoc 的步骤,包括设置环境变量和使用 REST API 的基本示例。 要查看完整的API,请参阅我们的REST API参考。
# Pull the latest IronSecureDoc Docker image
docker pull ironsoftwareofficial/ironsecuredoc:latest
先决条件
配备英特尔芯片的Mac电脑
搭载 Apple 芯片的 Mac
分步指南
1. 安装 Docker Desktop
如果您尚未安装 Docker Desktop,请按照以下步骤操作:
- 访问Docker Desktop下载页面。
- 下载适用于 Mac 的 Docker Desktop 安装程序。
- 运行安装程序并按照屏幕上的说明进行操作。
- 安装完成后,启动 Docker Desktop 并确保其正在运行。
2. 拉取“IronSecureDoc”Docker镜像
打开命令行界面,从 Docker Hub 拉取最新的 IronSecureDoc 镜像:
# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest
3. 无需证书即可运行容器
使用必要的环境变量运行 Docker 容器:
# Run the Docker container with environment variables
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 容器
如果需要使用证书运行容器,请按照以下步骤生成证书并配置本地计算机:
-
生成证书:
# Generate and trust HTTPS development certificate dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> dotnet dev-certs https --trustSHELL
将<CREDENTIAL_PLACEHOLDER>替换为密码。
-
运行Docker容器:
# Run the container with HTTPS support 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 $HOME/.aspnet/https:/https:ro \ -e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \ -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \ ironsoftwareofficial/ironsecuredoc:latestSHELL
<IRONSECUREDOC_LICENSE_KEY>和<CERTIFICATE_PASSWORD>分别替换为您的实际IronSecureDoc许可证密钥和证书密码。6. 管理容器
您可以使用 Docker 命令管理正在运行的容器。 以下是一些常用命令:
-
停止容器:
docker stop <container_id_or_name>SHELL -
启动容器:
docker start <container_id_or_name>SHELL -
移除容器:
docker rm -f <container_id_or_name>SHELL
环境变量
可以使用以下环境变量配置容器:
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参考。
编辑文本
# Redact specific words in a PDF document
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替换为您要编辑的词。
编辑正则表达式
# Redact text based on a regular expression in a PDF document
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参考。
常见问题
如何在我的Mac上运行IronSecureDoc?
要在Mac上运行IronSecureDoc,确保已安装并运行Docker Desktop。然后您可以拉取IronSecureDoc的Docker镜像,并使用必要的环境变量运行。
在Mac上托管IronSecureDoc的先决条件是什么?
在Mac上托管IronSecureDoc之前,您应该在系统上安装并运行Docker Desktop,兼容Intel和Apple硅芯片的Mac。
一旦IronSecureDoc容器运行,该如何访问?
您可以通过Web浏览器导航到'http://localhost:8080/swagger/index.html'来访问IronSecureDoc容器,您将看到IronSecureDoc界面。
如何使用证书运行IronSecureDoc容器?
要使用证书,请使用'dotnet dev-certs https'生成HTTPS开发证书。然后,使用适当的环境变量运行Docker容器,包括证书路径和其密码。
在IronSecureDoc中可以配置哪些环境变量?
IronSecureDoc中可配置的环境变量包括PDF_MAX_SIZE_MB,REQUEST_TIMEOUT_SECONDS,ALLOWED_ORIGINS,HTTP_PORTS,HTTPS_PORTS,和IronSecureDoc_LicenseKey。
如何使用IronSecureDoc在PDF中编辑文本?
您可以通过curl发送POST请求到IronSecureDoc API,带上文档和您想编辑文本的参数以编辑文本。
IronSecureDoc容器的用途是什么?
IronSecureDoc容器通过强大的PDF操作REST API提供离线文档安全和合规,减少对在线SaaS服务的依赖。
IronSecureDoc能否使用正则表达式处理PDF编辑?
是的,IronSecureDoc通过其REST API端点支持使用正则表达式进行PDF文本编辑,实现目标内容的移除。
如果容器需要支持HTTPS,您该怎么办?
生成HTTPS证书,使用'dotnet dev-certs'信任它,并使用环境变量运行Docker容器以指定证书路径和密码。
在哪里可以找到IronSecureDoc的完整REST API端点列表?
IronSecureDoc的完整REST API端点列表可以在文档中的REST API引用中找到。
Curtis Chau 拥有卡尔顿大学的计算机科学学士学位,专注于前端开发,精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面,喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。