1. IronSecureDoc
  2. Anleitungen
  3. Host unter Windows

Hosting unter Windows

This article was translated from English: Does it need improvement?
Translated
View the article in English

IronSecureDoc auf DockerIronSecureDoc ist ein Docker-Container, der entwickelt wurde, um Ihnen eine leistungsstarke PDF-Bearbeitung hinter einer einfachen REST-API zu ermöglichen, ohne den Aufwand und den Overhead von Online-SaaS-Diensten. Dieser Leitfaden führt Sie durch die Schritte zum Hosten von IronSecureDoc auf Ihrem Computer, einschließlich der Einrichtung von Umgebungsvariablen und einem grundlegenden Beispiel für die Verwendung der REST-API. Die vollständige API finden Sie in unseremREST-API-Referenz

docker pull ironsoftwareofficial/ironsecuredoc:latest

Voraussetzungen

Schritt-für-Schritt-Anleitung

1. Docker Desktop installieren

Wenn Sie Docker Desktop noch nicht installiert haben, folgen Sie diesen Schritten:

  1. Gehen Sie zumDocker Desktop Download-Seite.

  2. Laden Sie das Installationsprogramm für Docker Desktop für Windows herunter.

  3. Führen Sie das Installationsprogramm aus und folgen Sie den Anweisungen auf dem Bildschirm.

  4. Starten Sie nach der Installation Docker Desktop und stellen Sie sicher, dass es ausgeführt wird.

2. Ziehen Sie das "IronSecureDoc"-Docker-Abbild

Öffnen Sie eine Eingabeaufforderung und ziehen Sie das neueste IronSecureDoc-Image aus Docker Hub:

docker pull ironsoftwareofficial/ironsecuredoc:latest

3. Den Container ohne Zertifikat ausführen

Starten Sie den Docker-Container mit den erforderlichen Umgebungsvariablen: Swagger UI im Browser

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

Anwenden eines Test- oder Lizenzschlüssels zum Entfernen von Wasserzeichen

Tipps
Ersetzen Sie <IRONSECUREDOC_LICENSE_KEY> durch Ihren aktuellen IronSecureDoc-Lizenzschlüssel. Andernfalls wird ein Wasserzeichen auf die Unternehmensfunktionen angewendet. Swagger UI im Browser

4. Zugriff auf den Container

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


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

Swagger UI im BrowserSie sollten die IronSecureDoc-Schnittstelle sehen, die anzeigt, dass Ihr Container erfolgreich läuft.

5. Ausführen des IronSecureDoc-Containers mit Zertifikat

Wenn Sie den Container mit einem Zertifikat betreiben müssen, führen Sie die folgenden Schritte aus, um das Zertifikat zu erzeugen 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

Ersetzen Sie <CREDENTIAL_PLACEHOLDER> durch ein Passwort.

  1. Ausführen des Docker-Containers:
   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

Ersetzen Sie <IRONSECUREDOC_LICENSE_KEY> und <CERTIFICATE_PASSWORD> durch Ihren aktuellen IronSecureDoc-Lizenzschlüssel bzw. Ihr Zertifikatspasswort.

6. Verwaltung des Containers

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

  • Den Container anhalten:
  docker stop ironsecuredoc
  • Starten Sie den Container:
  docker start ironsecuredoc
  • Entfernen Sie den Container:
  docker rm -f ironsecuredoc

Umgebungsvariablen

Der Container kann mit den folgenden Umgebungsvariablen konfiguriert werden:

  • pDF_MAX_SIZE_MB(Voreinstellung: 30): Legt die maximal zulässige Dateigröße für PDF-Uploads in Megabyte fest.
  • aBFRAGEZEITÜBERSCHREITUNG_SEKUNDEN(Voreinstellung: 5): Legt die Timeout-Dauer in Sekunden für API-Anfragen fest. Bei einem Wert von -1 können die Anfragen unbegrenzt laufen.
  • eRLAUBTE_URSPRÜNGE": Konfiguriert die herkunftsübergreifende Ressourcennutzung(CORS) indem Sie zulässige Herkunfts-URLs angeben. Trennen Sie mehrere URLs durch Kommas. Verwenden Sie * oder all, um Anfragen von jedem Ursprung zuzulassen.
  • hTTP_PORTS": Definiert die HTTP-Ports, die der Container zur Verfügung stellt. Dies sollte mit der Port-Zuordnung mit dem Flag -p übereinstimmen(z.B., 8080). Trennen Sie mehrere Anschlüsse mit einem Semikolon(;).
  • hTTPS_PORTS": Definiert die HTTPS-Ports, die der Container zur Verfügung stellt. Dies sollte mit der Port-Zuordnung mit dem Flag -p übereinstimmen(z.B., 8081). Trennen Sie mehrere Anschlüsse mit einem Semikolon(;).
  • ironSecureDoc_LicenseKey"(Erforderlich): Legt den IronSecureDoc-Lizenzschlüssel fest. Wichtig! Geben Sie diesen Wert nicht öffentlich bekannt.

Einfaches Beispiel: Text in einem Dokument zensieren

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

Text redigieren

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 wollen, und sensitiveWord durch das Wort, das Sie schwärzen wollen.

Regulären Ausdruck umschreiben

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 zensieren wollen, und [0-9] mit dem regulären Ausdruck, den Sie abgleichen und redigieren wollen.

Schlussfolgerung

Sie haben IronSecureDoc erfolgreich auf Ihrem Rechner gehostet und mit den erforderlichen Umgebungsvariablen konfiguriert. Sie haben auch gelernt, wie man mit der IronSecureDoc REST API unter Verwendung von cURL sowohl für grundlegende als auch für erweiterte Operationen interagiert. Weitere Einzelheiten zur Konfiguration und Verwendung finden Sie in der vollständigenREST-API-Referenz.