1. IronSecureDoc
  2. Tutorials
  3. Auf Windows hosten

Wie man IronSecureDoc unter Windows mit C# hostet

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.

docker pull ironsoftwareofficial/ironsecuredoc:latest
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

Voraussetzungen

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 den Docker Desktop-Installer für Windows 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 Eingabeaufforderung und laden Sie das neueste IronSecureDoc-Image von Docker Hub herunter:

docker pull ironsoftwareofficial/ironsecuredoc:latest
docker pull ironsoftwareofficial/ironsecuredoc:latest
SHELL

3. Container ohne Zertifikat ausführen

Starten Sie den Docker-Container mit den erforderlichen Umgebungsvariablen:

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

Testversion oder Lizenzschlüssel anwenden, um Wasserzeichen zu entfernen

TippsReplace<IRONSECUREDOC_LICENSE_KEY> mit Ihrem tatsächlichen IronSecureDoc-Lizenzschlüssel. Andernfalls wird ein Wasserzeichen auf Enterprise-Funktionen angewendet.

Swagger UI in Browser

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
Swagger UI in Browser

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 :

    dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust
    dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trust
    SHELL

    Ersetzen<CREDENTIAL_PLACEHOLDER> mit einem Passwort.

  2. Docker-Container ausführen :

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

    Ersetzen<IRONSECUREDOC_LICENSE_KEY> Und<CERTIFICATE_PASSWORD> mit Ihrem jeweiligen IronSecureDoc-Lizenzschlüssel und 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>
    docker stop <container-id>
    SHELL

  • Container starten :

    docker start <container-id>
    docker start <container-id>
    SHELL

  • Entfernen Sie den Container :

    docker rm -f <container-id>
    docker rm -f <container-id>
    SHELL

Ersetzen<container-id> mit der tatsächlichen Container-ID oder dem Containernamen.

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

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

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

Was ist IronSecureDoc?

IronSecureDoc ist ein Docker-Container, der leistungsstarke PDF-Manipulation über eine einfache REST API bietet, speziell entwickelt für Offline-Dokumentensicherheit und Compliance.

Was sind die Systemanforderungen für das Hosten von IronSecureDoc auf Windows?

Um IronSecureDoc auf Windows zu hosten, benötigen Sie Windows 10 oder höher oder eine Windows Server-Version (2016, 2019, 2022) und Docker Desktop für Windows.

Wie kann ich Docker Desktop auf meinem Windows-Rechner installieren?

Laden Sie Docker Desktop von der offiziellen Docker-Website herunter, führen Sie das Installationsprogramm aus und folgen Sie den Installationsanweisungen. Nach der Installation starten Sie Docker Desktop, um es zu verwenden.

Wie lade ich das IronSecureDoc Docker-Image herunter?

Öffnen Sie Ihr Befehlszeilenfenster und führen Sie den Befehl aus: docker pull ironsoftwareofficial/ironsecuredoc:latest, um das IronSecureDoc-Image herunterzuladen.

Ist es möglich, IronSecureDoc ohne ein SSL-Zertifikat auszuführen?

Ja, Sie können den IronSecureDoc-Container ohne ein SSL-Zertifikat ausführen, indem Sie den Befehl ausführen: docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey= -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest, wobei Sie durch Ihren tatsächlichen Lizenzschlüssel ersetzen.

Wie kann ich auf die IronSecureDoc-Oberfläche zugreifen, sobald der Container läuft?

Sie können auf die IronSecureDoc-Oberfläche zugreifen, indem Sie einen Webbrowser öffnen und zu http://localhost:8080/swagger/index.html navigieren.

Wie konfiguriere ich IronSecureDoc mit einem SSL-Zertifikat?

Erzeugen Sie ein Zertifikat mit dotnet dev-certs und führen Sie dann den IronSecureDoc-Container mit dem Befehl aus, der den Zertifikatspfad und das Passwort für erhöhte Sicherheit beinhaltet.

Welche Umgebungsvariablen stehen zur Konfiguration des IronSecureDoc-Containers zur Verfügung?

Sie können verschiedene Umgebungsvariablen konfigurieren, wie PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS und IronSecureDoc_LicenseKey.

Wie kann ich sensible Informationen in einem PDF mit IronSecureDoc redigieren?

Um Text in einem PDF zu redigieren, verwenden Sie einen cURL-Befehl, um eine POST-Anfrage an die IronSecureDoc REST API zu senden, wobei Sie die PDF-Datei und den Text oder das Muster, das Sie redigieren möchten, angeben.

Wo finde ich ausführliche Dokumentation für die IronSecureDoc REST API?

Die vollständige REST API-Referenz für IronSecureDoc ist verfügbar unter /enterprise/securedoc/tutorials/use-rest-api/.

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