Alojamiento en Mac
IronSecureDoc 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 la API completa, vea nuestra Referencia de la API REST
docker pull ironsoftwareofficial/ironsecuredoc:latestRequisitos previos
Docker es compatible con Docker Desktop en las versiones más recientes de macOS. Es decir, la versión actual de macOS y las dos anteriores. A medida que nuevas versiones principales de macOS se hacen generalmente disponibles, Docker deja de soportar la versión más antigua y soporta la versión más reciente de macOS (además de las dos versiones anteriores).
Mac con chip Intel
Docker Desktop para Mac con chip Intel instalado y en funcionamiento
Mac con chip de Apple
- Docker Desktop para Mac con Apple silicon instalado y en funcionamiento
Guía paso a paso
1. Instalar Docker Desktop
Si aún no ha instalado Docker Desktop, siga estos pasos:
Vaya a la página de descarga de Docker Desktop.
Descargue el instalador de Docker Desktop para Windows.
Ejecute el instalador y siga las instrucciones que aparecen en pantalla.
- 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:latest3. Ejecutar el contenedor sin certificado
Ejecute el contenedor Docker con las variables de entorno necesarias:
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latestAplicar una clave de prueba o de licencia para eliminar las marcas de agua
Consejos
<IRONSECUREDOC_LICENSE_KEY> con su clave de licencia real de IronSecureDoc.] De lo contrario, se aplicará una marca de agua a las características de la empresa. 
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
Deberí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:
- Generar Certificado:
dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trustReemplace <CREDENTIAL_PLACEHOLDER> con una contraseña.
- Ejecuta el contenedor de 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:latestReemplace <IRONSECUREDOC_LICENSE_KEY> y <CERTIFICATE_PASSWORD> con su clave de licencia de IronSecureDoc y la contraseña de certificado respectivas.
6. Gestión del contenedor
Puede gestionar su contenedor en ejecución mediante comandos Docker. Aquí tienes algunos comandos útiles:
- Detener el contenedor:
docker stop ironsecuredoc- Iniciar el contenedor:
docker start ironsecuredoc- Eliminar el contenedor:
docker rm -f ironsecuredocVariables de entorno
El contenedor puede configurarse utilizando las siguientes variables de entorno:
PDF_MAX_SIZE_MB(Por defecto: 30): Establece el tamaño máximo permitido para los archivos PDF subidos en Megabytes.REQUEST_TIMEOUT_SECONDS(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 el Intercambio de Recursos de Origen Cruzado (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 debería coincidir con el mapeo de puertos utilizando el indicador -p (por ejemplo, 8080). Separe varios puertos con un punto y coma (;).HTTPS_PORTS: Define los puertos HTTPS que expone el contenedor. Esto debería coincidir con el mapeo de puertos usando la opción -p (por ejemplo, 8081). Separe varios puertos con un 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 la lista completa de puntos finales de la 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'Reemplace /path/to/your/document.pdf con la ruta real del documento que desea redactar y sensitiveWord con 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'Sustituye /path/to/your/document.pdf por la ruta real del documento que deseas redactar y [0-9] por la expresión regular que deseas 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 obtener más detalles sobre la configuración y uso, consulte la Referencia de REST API completa.
