1. IronSecureDoc
  2. Tutoriales
  3. Azure Host y configuración

Alojamiento en Linux

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

IronSecureDoc en DockerIronSecureDoc es un contenedor Docker diseñado para ofrecerle una potente manipulación de PDF detrás de una sencilla API REST, sin la molestia y la sobrecarga de los servicios SaaS en línea. Esta guía le guiará a través de los pasos para alojar IronSecureDoc en su máquina, incluyendo la configuración de variables de entorno y un ejemplo básico de uso de la API REST. Para obtener la API completa, consulte nuestra**Referencia de la API REST

docker pull ironsoftwareofficial/ironsecuredoc:latest

Requisitos previos

Antes de proceder

Docker Desktop en Linux ejecuta una máquina virtual(VM) que crea y utiliza un contexto docker personalizado, desktop-linux, al iniciarse.

Esto significa que las imágenes y contenedores desplegados en el motor Docker de Linux(antes de la instalación) no están disponibles en Docker Desktop para Linux.

Plataformas

Guía paso a paso

1. Instalar Docker Desktop

Si aún no ha instalado Docker Desktop, siga estos pasos:

  1. Ir a laPágina de descarga de Docker Desktop.

  2. Descargue el instalador de Docker Desktop para Linux.

  3. Ejecute el instalador y siga las instrucciones que aparecen en pantalla.

  4. Tras la instalación, inicie Docker Desktop y asegúrese de que se está ejecutando.

2. Extraiga la imagen Docker "IronSecureDoc

Abra un símbolo del sistema y extraiga la última imagen de IronSecureDoc de Docker Hub:

docker pull ironsoftwareofficial/ironsecuredoc:latest

3. Ejecutar el contenedor sin certificado

Ejecute el contenedor Docker con las variables de entorno necesarias: Swagger UI en el navegador

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

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

Consejos
Sustituya <IRONSECUREDOC_LICENSE_KEY> por su clave de licencia real de IronSecureDoc. De lo contrario, se aplicará una marca de agua a las características de la empresa. Swagger UI en el navegador

4. Acceder al contenedor

Una vez que el contenedor está en funcionamiento, puede acceder a IronSecureDoc abriendo un navegador web y navegando a:


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

Swagger UI en el navegadorDebería ver la interfaz IronSecureDoc, indicando que su contenedor se está ejecutando correctamente.

5. Ejecutar el contenedor IronSecureDoc con certificado

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

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

Sustituya <CREDENTIAL_PLACEHOLDER> por una contraseña.

  1. Ejecute el contenedor 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

Sustituya <IRONSECUREDOC_LICENSE_KEY> y <CERTIFICATE_PASSWORD> por la clave de licencia de IronSecureDoc y la contraseña del certificado, respectivamente.

6. Gestión del contenedor

Puede gestionar su contenedor en ejecución mediante comandos Docker. Aquí tienes algunos comandos útiles:

  • Para el contenedor:
  docker stop ironsecuredoc
  • Inicia el contenedor:
  docker start ironsecuredoc
  • Retira el contenedor:
  docker rm -f ironsecuredoc

Variables de entorno

El contenedor puede configurarse utilizando las siguientes variables de entorno:

  • tAMAÑO_MAX_PDF_MB(Predeterminado: 30): Establece el tamaño máximo de archivo permitido para subir archivos PDF en Megabytes.
  • SEGUNDOS_DE_TIEMPO_DE_ESPERA_DE_SOLICITUD(Predeterminado: 5): Establece la duración del tiempo de espera en segundos para las solicitudes API. Un valor de -1 permite que las peticiones se ejecuten indefinidamente.
  • ALLOWED_ORIGINS: Configura la compartición de recursos entre orígenes(CORS) especificando las URL de origen permitidas. Separe varias URL con comas. Utilice * o all para permitir solicitudes de cualquier origen.
  • HTTP_PORTS: Define los puertos HTTP que expone el contenedor. Esto debe coincidir con la asignación de puertos utilizando la bandera -p(por ejemplo, 8080). Separe varios puertos con punto y coma(;).

  • HTTPS_PORTS: Define los puertos HTTPS que expone el contenedor. Esto debe coincidir con la asignación de puertos utilizando la bandera -p(por ejemplo, 8081). Separe varios puertos con punto y coma(;).

    IronSecureDoc_LicenseKey(Requerido): Establece la clave de licencia de IronSecureDoc. Importante: No comparta este valor públicamente.

Ejemplo básico: Redactar texto en un documento

Para obtener la lista completa de puntos finales de la API, consulte la versión completa de**Referencia de la API REST.

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'

Sustituya ruta/al/documento.pdf por la ruta real al documento que desea redactar y palabra_sensible por la palabra que desea redactar.

Redactar expresión regular

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'

Sustituya /ruta/al/documento.pdf por la ruta real al documento que desea redactar y [0-9] con la expresión regular que desea hacer coincidir y redactar.

Conclusión

Ha alojado correctamente IronSecureDoc en su equipo y lo ha configurado con las variables de entorno necesarias. También aprendió a interactuar con la API REST de IronSecureDoc utilizando cURL para operaciones básicas y avanzadas. Para más detalles sobre la configuración y el uso, consulte el documento completo**Referencia de la API REST.