Host IronSecureDoc on Mac with C# API

1. Docker Desktop installieren

Falls Sie Docker Desktop noch nicht installiert haben, befolgen Sie diese Schritte:

1. Gehen Sie zur Downloadseite von Docker Desktop .
2. Laden Sie das Docker Desktop-Installationsprogramm für Mac herunter.
3. Starten Sie das Installationsprogramm und folgen Sie den Anweisungen auf dem Bildschirm.
4. Starten Sie nach der Installation Docker Desktop und vergewissern Sie sich, dass es ausgeführt wird.

2. Laden Sie das Docker-Image "IronSecureDoc" herunter.

Öffnen Sie eine Befehlszeilenschnittstelle und laden Sie das neueste IronSecureDoc-Image von Docker Hub herunter:

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

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

3. Container ohne Zertifikat ausführen

Starten Sie den Docker-Container mit den erforderlichen Umgebungsvariablen:

# 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

Ersetzen Sie <IRONSECUREDOC_LICENSE_KEY> durch Ihren tatsächlichen IronSecureDoc-Lizenzschlüssel. Andernfalls wird ein Wasserzeichen auf die Enterprise-Funktionen angewendet.

4. Zugriff auf den Container

Sobald der Container läuft, können Sie auf IronSecureDoc zugreifen, indem Sie einen Webbrowser öffnen und zu folgender Adresse navigieren:

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

Sie sollten die IronSecureDoc-Oberfläche sehen, was darauf hinweist, dass Ihr Container erfolgreich ausgeführt wird.

5. Führen Sie den IronSecureDoc-Container mit Zertifikat aus.

Falls Sie den Container mit einem Zertifikat ausführen müssen, befolgen Sie diese Schritte, um das Zertifikat zu generieren und den lokalen Rechner zu konfigurieren:

1. Zertifikat generieren :

   # 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

   Ersetzen Sie <CREDENTIAL_PLACEHOLDER> durch ein Passwort.

2. Docker-Container ausführen :

   # 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
   TippsErsetzen Sie <IRONSECUREDOC_LICENSE_KEY> und <CERTIFICATE_PASSWORD> durch Ihren tatsächlichen IronSecureDoc-Lizenzschlüssel bzw. Ihr Zertifikatpasswort.

6. Verwaltung des Containers

Sie können Ihren laufenden Container mithilfe von Docker-Befehlen verwalten. Hier sind einige nützliche Befehle:

• Container stoppen :

  docker stop <container_id_or_name>

  docker stop <container_id_or_name>

  SHELL

• Container starten :

  docker start <container_id_or_name>

  docker start <container_id_or_name>

  SHELL

• Entfernen Sie den Container :

  docker rm -f <container_id_or_name>

  docker rm -f <container_id_or_name>

  SHELL

Text schwärzen

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

Ersetzen Sie /path/to/your/document.pdf durch den tatsächlichen Pfad zu dem Dokument, das Sie schwärzen möchten, und sensitiveWord durch das Wort, das Sie schwärzen möchten.

Redact Regular Expression

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

Ersetzen Sie /path/to/your/document.pdf durch den tatsächlichen Pfad zu dem Dokument, das Sie schwärzen möchten, und [0-9] durch den regulären Ausdruck, den Sie abgleichen und schwärzen möchten.

Abschluss

Sie haben IronSecureDoc erfolgreich auf Ihrem Rechner gehostet und mit den erforderlichen Umgebungsvariablen konfiguriert. Sie haben außerdem gelernt, wie Sie mit der IronSecureDoc REST-API mithilfe von cURL sowohl für einfache als auch für fortgeschrittene Operationen interagieren können. Weitere Details zur Konfiguration und Verwendung finden Sie in der REST-API-Referenz.