Hosting IronSecureDoc on Linux Using C

IronSecureDoc 是一个 Docker 容器,旨在通过简单的 REST API 为您提供强大的 PDF 操作功能,而无需在线 SaaS 服务的麻烦和开销。 本指南将引导您完成在计算机上托管 IronSecureDoc 的步骤,包括设置环境变量和使用 REST API 的基本示例。 如需了解完整的 API,请查看我们的REST API 参考文档。
docker pull ironsoftwareofficial/ironsecuredoc:latestdocker pull ironsoftwareofficial/ironsecuredoc:latest前提条件
Linux 上的 Docker Desktop 运行一个虚拟机 (VM),该虚拟机在启动时创建并使用自定义 Docker 上下文。desktop-linux
这意味着在 Linux Docker Engine 上部署的镜像和容器(安装之前)在 Linux 版 Docker Desktop 中不可用。
平台
- Ubuntu (x86_64 / amd64) - 下载 Docker Desktop 的链接
- Debian (x86_64 / amd64) - 下载 Docker Desktop 的链接
- Fedora (x86_64 / amd64) - 下载 Docker Desktop 的链接
- Red Hat Enterprise Linux (x86_64 / amd64) - Docker Desktop 下载链接
分步指南
1. 安装 Docker Desktop
如果您尚未安装 Docker Desktop,请按照以下步骤操作:
- 前往Docker Desktop 下载页面。
- 下载适用于 Linux 的 Docker Desktop 安装程序。
- 运行安装程序并按照屏幕上的说明进行操作。
- 安装完成后,启动 Docker Desktop 并确保其正在运行。
2. 拉取"IronSecureDoc"Docker镜像
打开命令提示符,从 Docker Hub 拉取最新的 IronSecureDoc 镜像:
docker pull ironsoftwareofficial/ironsecuredoc:latestdocker 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:latestdocker 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 容器
如果需要使用证书运行容器,请按照以下步骤生成证书并配置本地机器:
1.生成证书:
dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust dotnet dev-certs https -ep $HOME/.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 $HOME/.aspnet/https:/https:ro \
-e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \
-e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \
ironsoftwareofficial/ironsecuredoc:latest 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:latest将 <IRONSECUREDOC_LICENSE_KEY> 和 <CERTIFICATE_PASSWORD> 分别替换为您的实际 IronSecureDoc 许可证密钥和证书密码。
6. 管理容器
您可以使用 Docker 命令管理正在运行的容器。 下面是一些有用的命令:
-停止容器:
docker stop <container_id> docker stop <container_id>-启动容器:
docker start <container_id> docker start <container_id>-移除容器:
docker rm -f <container_id> docker rm -f <container_id>将 <container_id> 替换为实际的容器 ID 或名称。
环境变量
可以使用以下环境变量配置容器:
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'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'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 参考文档。
常见问题解答
什么是 IronSecureDoc,它如何工作?
IronSecureDoc 是一个 Docker 容器,通过 REST API 提供强大的 PDF 操作功能,使文档安全无需依赖 SaaS 服务。
在 Linux 服务器上设置 IronSecureDoc 的要求是什么?
要在 Linux 服务器上设置 IronSecureDoc,请确保在 Linux 发行版上安装了 Docker Desktop,如 Ubuntu、Debian、Fedora 或 Red Hat Enterprise Linux。
如何下载 IronSecureDoc Docker 镜像?
通过在终端中执行命令:docker pull ironsoftwareofficial/ironsecuredoc:latest 下载 IronSecureDoc Docker 镜像。
是否可以在没有 SSL 证书的情况下运行 IronSecureDoc 容器?
是的,您可以通过使用命令:docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey= 来运行未使用 SSL 证书的容器。
如何在我的浏览器上访问 IronSecureDoc 界面?
启动容器后,通过在网页浏览器中访问 http://localhost:8080/swagger/index.html 访问 IronSecureDoc 界面。
如何生成并信任 IronSecureDoc 的 SSL 证书?
使用以下命令生成 SSL 证书:dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p 并使用命令:dotnet dev-certs https --trust 来信任它。
IronSecureDoc 可配置的环境变量有哪些?
IronSecureDoc 中可配置的环境变量包括 PDF_MAX_SIZE_MB、REQUEST_TIMEOUT_SECONDS、ALLOWED_ORIGINS、HTTP_PORTS、HTTPS_PORTS 和 IronSecureDoc_LicenseKey。
如何使用 IronSecureDoc 在 PDF 中进行文本删除?
使用 cURL 命令通过 API 编辑 PDF 中的文本:curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' 并附上所需的表单数据。
我应该使用哪个命令来停止运行的 IronSecureDoc Docker 容器?
使用以下命令停止正在运行的 Docker 容器:docker stop。
哪里可以找到 IronSecureDoc 的 API 端点的完整列表?
完整的 API 端点列表可在 IronSecureDoc 网站的 REST API 参考中找到。





