1. IronSecureDoc
  2. Tutoriales
  3. Alojar en Mac

Aloje IronSecureDoc en Mac con la API de 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, consulta nuestra Referencia de API REST.

# Pull the latest IronSecureDoc Docker image
docker pull ironsoftwareofficial/ironsecuredoc:latest
# Pull the latest IronSecureDoc Docker image
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

Requisitos previos

AdvertenciaDocker admite Docker Desktop en las versiones más recientes de macOS. Es decir, la versión actual de macOS y las dos versiones anteriores. A medida que se ponen a disposición del público nuevas versiones principales de macOS, Docker deja de ofrecer soporte para la versión más antigua y ofrece soporte para la versión más nueva de macOS (además de las dos versiones anteriores).

Mac con chip Intel

Mac con silicio de Apple

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 Mac.
  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"

Abra una interfaz de línea de comandos y extraiga la última imagen de IronSecureDoc desde Docker Hub:

# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest
# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

3. Ejecute el contenedor sin certificado

Inicia el contenedor Docker con las variables de entorno necesarias:

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

Reemplaza <IRONSECUREDOC_LICENSE_KEY> con tu clave de licencia real de IronSecureDoc. De lo contrario, se aplicará una marca de agua en las Funciones Empresariales.

4. Acceda al contenedor

4. Acceder al Contenedor

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

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:

  # Generate and trust HTTPS development certificate
  dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
  dotnet dev-certs https --trust
  # Generate and trust HTTPS development certificate
  dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
  dotnet dev-certs https --trust
SHELL
  1. Generar Certificado:

Reemplaza <CREDENTIAL_PLACEHOLDER> con una contraseña.

  # 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:latest
  # 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:latest
SHELL

ConsejosReemplazar<IRONSECUREDOC_LICENSE_KEY> y<CERTIFICATE_PASSWORD> con su clave de licencia IronSecureDoc real 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_or_name>
  docker stop <container_id_or_name>
SHELL

  • Detener el contenedor:

    docker start <container_id_or_name>
    docker start <container_id_or_name>
    SHELL

  • Iniciar el contenedor:

    docker rm -f <container_id_or_name>
    docker rm -f <container_id_or_name>
    SHELL

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. - REQUEST_TIMEOUT_SECONDS (Por defecto: 5): Establece el tiempo de espera para solicitudes API en segundos.
  • 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. - HTTP_PORTS: Define los puertos HTTP que el contenedor expone. Separe múltiples puertos con un punto y coma (;).
  • HTTPS_PORTS: Define los puertos HTTPS que el contenedor expone. - HTTPS_PORTS: Define los puertos HTTPS que el contenedor expone. 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

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

# 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'
# 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'
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é pasos son necesarios para alojar el contenedor de IronSecureDoc en macOS?

Para alojar el contenedor de IronSecureDoc en macOS, necesitas instalar Docker Desktop, extraer la última imagen de Docker de IronSecureDoc y configurar el contenedor con variables de entorno como IronSecureDoc_LicenseKey, PDF_MAX_SIZE_MB y REQUEST_TIMEOUT_SECONDS. Se proporcionan instrucciones detalladas en el tutorial.

¿Cómo puedo ejecutar el contenedor de IronSecureDoc con soporte HTTPS en un Mac?

Para ejecutar el contenedor de IronSecureDoc con HTTPS en un Mac, genera un certificado usando dotnet dev-certs, luego ejecuta el contenedor con el comando apropiado que incluya -v para volumen y -e para variables de entorno, especificando las rutas y contraseñas del certificado.

¿Cómo accedo a la interfaz de IronSecureDoc una vez que el contenedor de Docker está en ejecución en macOS?

Una vez que el contenedor de Docker está en ejecución en macOS, puedes acceder a la interfaz de IronSecureDoc visitando http://localhost:8080/swagger/index.html en tu navegador web.

¿Cuáles son los requisitos previos para instalar Docker Desktop en macOS?

Para instalar Docker Desktop en macOS, asegura que tu Mac esté ejecutando una versión compatible de macOS, que incluye la versión actual y las dos versiones anteriores. Además, asegúrate de seleccionar el instalador compatible con tu procesador, ya sea Intel o Apple Silicon.

¿Cómo puedo redactar palabras o patrones en un PDF usando el contenedor de Docker de IronSecureDoc?

Puedes redactar palabras o patrones en un PDF enviando una solicitud POST al endpoint de la API de IronSecureDoc, usando herramientas como cURL, especificando el archivo PDF y las palabras o patrones a redactar.

¿Qué variables de entorno se pueden configurar para el contenedor de IronSecureDoc en macOS?

Las variables de entorno para el contenedor de IronSecureDoc incluyen PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS y IronSecureDoc_LicenseKey.

¿Cómo puedo extraer la última imagen de Docker de IronSecureDoc en macOS?

Para extraer la última imagen de Docker de IronSecureDoc en macOS, ejecuta el comando: docker pull ironsoftwareofficial/ironsecuredoc:latest en tu terminal.

¿Cuáles son algunos comandos básicos de Docker para gestionar el contenedor de IronSecureDoc en Mac?

Los comandos básicos de Docker para gestionar el contenedor de IronSecureDoc incluyen docker stop , docker start y docker rm -f .

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?
Version: 2024.10 recién lanzado