1. IronSecureDoc
  2. Tutorials
  3. Auf Mac hosten

Hosten Sie IronSecureDoc auf dem Mac mit der C#-API.

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

IronSecureDoc ist ein Docker-Container, der Ihnen leistungsstarke PDF-Manipulationsmöglichkeiten über eine einfache REST-API bietet, ohne den Aufwand und die Kosten von Online-SaaS-Diensten. Dieser Leitfaden führt Sie durch die Schritte zum Hosten von IronSecureDoc auf Ihrem Rechner, einschließlich der Einrichtung von Umgebungsvariablen und eines einfachen Beispiels für die Verwendung der REST-API. Die vollständige API finden Sie in unserer REST-API-Referenz .

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

Voraussetzungen

WarnungDocker unterstützt Docker Desktop auf den neuesten Versionen von macOS. Das heißt, die aktuelle Version von macOS und die beiden vorherigen Versionen. Mit der allgemeinen Verfügbarkeit neuer Hauptversionen von macOS stellt Docker die Unterstützung für die älteste Version ein und unterstützt fortan die neueste Version (zusätzlich zu den beiden vorherigen Versionen).

Mac mit Intel-Chip

Mac mit Apple Silicon

Schritt-für-Schritt-Anleitung

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
SHELL

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
SHELL

Ersetzen<IRONSECUREDOC_LICENSE_KEY> mit Ihrem 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<CREDENTIAL_PLACEHOLDER> mit einem 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

    TippsReplace<IRONSECUREDOC_LICENSE_KEY> Und<CERTIFICATE_PASSWORD> mit Ihrem tatsächlichen IronSecureDoc-Lizenzschlüssel bzw. Zertifikatspasswort.

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

Umgebungsvariablen

Der Container kann mithilfe der folgenden Umgebungsvariablen konfiguriert werden:

  • PDF_MAX_SIZE_MB (Standard: 30): Legt die maximal zulässige Dateigröße für PDF-Uploads in Megabyte fest.
  • REQUEST_TIMEOUT_SECONDS (Standardwert: 5): Legt die Timeout-Dauer in Sekunden für API-Anfragen fest. Ein Wert von -1 ermöglicht es, Anfragen unbegrenzt auszuführen.
  • ALLOWED_ORIGINS : Konfiguriert Cross-Origin Resource Sharing (CORS) durch Angabe zulässiger Ursprungs-URLs. Mehrere URLs müssen durch Kommas getrennt werden. Verwenden Sie * oder all um Anfragen von beliebigen Ursprüngen zuzulassen.
  • HTTP_PORTS : Definiert die HTTP-Ports, die der Container bereitstellt. Dies sollte der Portzuordnung mit dem Parameter -p entsprechen (z. B. 8080). Mehrere Ports werden durch ein Semikolon ( ; ) getrennt.
  • HTTPS_PORTS : Definiert die HTTPS-Ports, die der Container bereitstellt. Dies sollte der Portzuordnung mit dem Parameter -p entsprechen (z. B. 8081). Mehrere Ports werden durch ein Semikolon ( ; ) getrennt.
  • IronSecureDoc_LicenseKey (Erforderlich): Legt den IronSecureDoc-Lizenzschlüssel fest. Wichtig: Geben Sie diesen Wert nicht öffentlich weiter.

Einfaches Beispiel: Text in einem Dokument schwärzen

Die vollständige Liste der API-Endpunkte finden Sie in der vollständigen REST-API-Referenz .

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

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

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.

Häufig gestellte Fragen

Welche Schritte sind erforderlich, um den IronSecureDoc-Container auf macOS zu hosten?

Um den IronSecureDoc-Container auf macOS zu hosten, müssen Sie Docker Desktop installieren, das neueste IronSecureDoc-Docker-Image ziehen und den Container mit Umgebungsvariablen wie IronSecureDoc_LicenseKey, PDF_MAX_SIZE_MB und REQUEST_TIMEOUT_SECONDS konfigurieren. Detaillierte Anweisungen sind im Tutorial gegeben.

Wie kann ich den IronSecureDoc-Container mit HTTPS-Unterstützung auf einem Mac ausführen?

Um den IronSecureDoc-Container mit HTTPS auf einem Mac auszuführen, generieren Sie ein Zertifikat mit dotnet dev-certs und führen Sie den Container mit dem passenden Befehl aus, der -v für Volumen und -e für Umgebungsvariablen umfasst, und geben Sie Zertifikatspfade und Passwörter an.

Wie greife ich auf die IronSecureDoc-Oberfläche zu, sobald der Docker-Container auf macOS läuft?

Sobald der Docker-Container auf macOS läuft, können Sie auf die IronSecureDoc-Oberfläche zugreifen, indem Sie http://localhost:8080/swagger/index.html in Ihrem Webbrowser besuchen.

Was sind die Voraussetzungen für die Installation von Docker Desktop auf macOS?

Um Docker Desktop auf macOS zu installieren, stellen Sie sicher, dass Ihr Mac eine unterstützte Version von macOS ausführt, die die aktuelle Veröffentlichung und die zwei vorherigen umfasst. Außerdem stellen Sie sicher, dass Sie den Installer auswählen, der mit Ihrem Prozessor kompatibel ist, entweder Intel oder Apple Silicon.

Wie kann ich Worte oder Muster in einem PDF mit dem IronSecureDoc-Docker-Container schwärzen?

Sie können Wörter oder Muster in einem PDF schwärzen, indem Sie eine POST-Anfrage an den IronSecureDoc-API-Endpunkt senden, mit Tools wie cURL, wobei die PDF-Datei und die zu schwärzenden Wörter oder Muster angegeben werden.

Welche Umgebungsvariablen können für den IronSecureDoc-Container auf macOS festgelegt werden?

Umgebungsvariablen für den IronSecureDoc-Container umfassen PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS, und IronSecureDoc_LicenseKey.

Wie ziehe ich das neueste IronSecureDoc-Docker-Image auf macOS?

Um das neueste IronSecureDoc-Docker-Image auf macOS zu ziehen, führen Sie den Befehl: docker pull ironsoftwareofficial/ironsecuredoc:latest in Ihrem Terminal aus.

Was sind einige grundlegende Docker-Befehle zum Verwalten des IronSecureDoc-Containers auf Mac?

Grundlegende Docker-Befehle zum Verwalten des IronSecureDoc-Containers umfassen docker stop , docker start , und docker rm -f .

Curtis Chau
Curtis Chau
  Jetzt mit dem Ingenieurteam chatten
Technischer Autor

Curtis Chau hat einen Bachelor-Abschluss in Informatik von der Carleton University und ist spezialisiert auf Frontend-Entwicklung mit Expertise in Node.js, TypeScript, JavaScript und React. Leidenschaftlich widmet er sich der Erstellung intuitiver und ästhetisch ansprechender Benutzerschnittstellen und arbeitet gerne mit modernen Frameworks sowie der Erstellung gut strukturierter, optisch ansprechender ...

Weiterlesen
Bereit anzufangen?
Version: 2024.10 gerade veröffentlicht