1. IronSecureDoc
  2. Tutoriales
  3. Alojar en Windows

Cómo alojar IronSecureDoc en Windows con C#

Curtis Chau
Curtis Chau
Actualizado:
This article was translated from English: Does it need improvement?
Translated
View the article in English
IronSecureDoc on Docker

IronSecureDoc es un contenedor Docker diseñado para ofrecerte una poderosa manipulación de PDF detrás de una simple API REST, sin las complicaciones y sobrecarga de servicios SaaS en línea. Esta guía te guiará a través de los pasos para hospedar IronSecureDoc en tu máquina, incluyendo la configuración de variables de entorno y un ejemplo básico de uso de la API REST. Para ver la API completa, consulte nuestra Referencia de REST API

docker pull ironsoftwareofficial/ironsecuredoc:latest
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

Requisitos previos

Guía paso a paso

1. Instalar Docker Desktop

Si aún no has instalado Docker Desktop, sigue estos pasos:

  1. Ve a la página de descarga de Docker Desktop.
  2. Descargue el instalador de Docker Desktop para Windows.
  3. Ejecuta el instalador y sigue las instrucciones en pantalla.
  4. Después de la instalación, inicia Docker Desktop y asegúrate de que esté en funcionamiento.

2. Extraiga la imagen Docker "IronSecureDoc"

Abre un símbolo del sistema y descarga la última imagen de IronSecureDoc desde Docker Hub:

docker pull ironsoftwareofficial/ironsecuredoc:latest
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

3. Ejecute el contenedor sin certificado

Inicia el contenedor Docker con las variables de entorno necesarias:

Swagger UI in Browser
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest
SHELL

Aplicar una prueba o una clave de licencia para eliminar marcas de agua

ConsejosReemplazar<IRONSECUREDOC_LICENSE_KEY> con su clave de licencia real de IronSecureDoc. De lo contrario, se aplicará una marca de agua en las funciones empresariales.

Swagger UI in Browser

4. Acceda al contenedor

4. Acceder al Contenedor

http://localhost:8080/swagger/index.html
Swagger UI in Browser

Swagger UI in Browser

5. Ejecute el contenedor IronSecureDoc con certificado

5. Ejecutar el Contenedor IronSecureDoc con Certificado

Si necesitas ejecutar el contenedor con un certificado, sigue estos pasos para generar el certificado y configurar la máquina local:

   dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
   dotnet dev-certs https --trust
   dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
   dotnet dev-certs https --trust
SHELL
  1. Generar Certificado:

Reemplaza <CREDENTIAL_PLACEHOLDER> con una contraseña.

   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
   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
SHELL

Reemplace <IRONSECUREDOC_LICENSE_KEY> y <CERTIFICATE_PASSWORD> con su clave de licencia real de IronSecureDoc y la contraseña del certificado respectivamente.

6. Gestión del contenedor

6. Gestionando el Contenedor Puedes gestionar tu contenedor en ejecución usando comandos de Docker.

Aquí tienes algunos comandos útiles:

  docker stop <container-id>
  docker stop <container-id>
SHELL

  • Detener el contenedor:

    docker start <container-id>
    docker start <container-id>
    SHELL

  • Iniciar el contenedor:

    docker rm -f <container-id>
    docker rm -f <container-id>
    SHELL

Reemplace <container-id> con el ID o nombre real del contenedor.

Variables de entorno

Variables de Entorno

  • PDF_MAX_SIZE_MB (Por defecto: 30): Establece el tamaño máximo permitido para la carga de archivos PDF en Megabytes.
  • PDF_MAX_SIZE_MB (Por defecto: 30): Establece el tamaño máximo permitido para la carga de archivos PDF en Megabytes. Un valor de -1 permite que las solicitudes se ejecuten indefinidamente.
  • ALLOWED_ORIGINS: Configura el intercambio de recursos de origen cruzado (CORS) especificando las URL de origen permitidas. - ALLOWED_ORIGINS: Establece CORS especificando las URL de origen permitidas. Use * o all para permitir solicitudes desde cualquier origen.
  • HTTP_PORTS: Define los puertos HTTP que el contenedor expone. Debe coincidir con la asignación de puertos mediante la bandera -p (por ejemplo, 8080). Separe múltiples puertos con un punto y coma (;).
  • HTTPS_PORTS: Define los puertos HTTPS que el contenedor expone. Debe coincidir con la asignación de puertos mediante la bandera -p (por ejemplo, 8081). Separe múltiples puertos con un punto y coma (;).
    Esto debe coincidir con el mapeo de puertos usando el flag -p (por ejemplo, 8081). - IronSecureDoc_LicenseKey (Requerido): Establece la clave de licencia de IronSecureDoc.

Ejemplo básico: redactar texto en un documento

Para obtener la lista completa de puntos finales de API, consulte la Referencia de la API REST completa.

Redactar texto

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'
SHELL

Reemplace /path/to/your/document.pdf con la ruta real al documento que desea redactar y sensitiveWord con la palabra que desea redactar.

Redactar expresiones regulares

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'
SHELL

Reemplace /path/to/your/document.pdf con la ruta real al documento que desea redactar y [0-9] con la expresión regular que desea coincidir y redactar.

Conclusión

Reemplaza /path/to/your/document.pdf con la ruta real del documento y [0-9] con la expresión regular que deseas reducir. Has hospedado exitosamente IronSecureDoc en tu máquina y lo has configurado con las variables de entorno necesarias. Para obtener más detalles sobre la configuración y el uso, consulte la Referencia de la API REST completa.

Preguntas Frecuentes

¿Qué es IronSecureDoc?

IronSecureDoc es un contenedor de Docker que ofrece una potente manipulación de PDF a través de una sencilla REST API, diseñada específicamente para la seguridad y cumplimiento de documentos fuera de línea.

¿Cuáles son los requisitos del sistema para hospedar IronSecureDoc en Windows?

Para hospedar IronSecureDoc en Windows, necesitas Windows 10 o posterior, o una versión de Windows Server (2016, 2019, 2022) y Docker Desktop para Windows instalado.

¿Cómo puedo instalar Docker Desktop en mi máquina Windows?

Descarga Docker Desktop desde el sitio web oficial de Docker, ejecuta el instalador y sigue las instrucciones de instalación. Una vez instalado, inicia Docker Desktop para comenzar a usarlo.

¿Cómo descargo la imagen de Docker de IronSecureDoc?

Abre tu símbolo del sistema y ejecuta el comando: docker pull ironsoftwareofficial/ironsecuredoc:latest para descargar la imagen de IronSecureDoc.

¿Es posible ejecutar IronSecureDoc sin un certificado SSL?

Sí, puedes ejecutar el contenedor IronSecureDoc sin un certificado SSL ejecutando el comando: docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=-e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest, reemplazandocon tu clave de licencia real.

¿Cómo puedo acceder a la interfaz de IronSecureDoc una vez que el contenedor está en funcionamiento?

Puedes acceder a la interfaz de IronSecureDoc abriendo un navegador web y navegando a http://localhost:8080/swagger/index.html.

¿Cómo configuro IronSecureDoc con un certificado SSL?

Genera un certificado usando dotnet dev-certs y luego ejecuta el contenedor de IronSecureDoc con el comando que incluye la ruta del certificado y la contraseña para mejorar la seguridad.

¿Qué variables de entorno están disponibles para configurar el contenedor IronSecureDoc?

Puedes configurar varias variables de entorno como PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS y IronSecureDoc_LicenseKey.

¿Cómo puedo redactar información sensible en un PDF usando IronSecureDoc?

Para redactar texto en un PDF, usa un comando cURL para enviar una solicitud POST a la REST API de IronSecureDoc, especificando el archivo PDF y el texto o patrón a redactar.

¿Dónde puedo encontrar documentación detallada para la REST API de IronSecureDoc?

La referencia completa de la REST API para IronSecureDoc está disponible en /enterprise/securedoc/tutorials/use-rest-api/.

Curtis Chau
Curtis Chau
  Chatea con el equipo de ingeniería ahora
Escritor Técnico

Curtis Chau tiene una licenciatura en Ciencias de la Computación (Carleton University) y se especializa en el desarrollo front-end con experiencia en Node.js, TypeScript, JavaScript y React. Apasionado por crear interfaces de usuario intuitivas y estéticamente agradables, disfruta trabajando con frameworks modernos y creando manuales bien ...

Leer más
¿Listo para empezar?
Versión: 2024.10 recién lanzado