Hosting unter Linux
IronSecureDoc 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. Für die vollständige API, sehen Sie sich unsere REST-API-Referenz an.
docker pull ironsoftwareofficial/ironsecuredoc:latestVoraussetzungen
Bevor Sie fortfahren
Docker Desktop unter Linux führt eine virtuelle Maschine (VM) aus, die beim Start einen benutzerdefinierten Docker-Kontext desktop-linux erstellt und verwendet.
Dies bedeutet, dass Bilder und Container, die auf der Linux Docker Engine bereitgestellt werden (vor der Installation), in Docker Desktop für Linux nicht verfügbar sind.
Plattformen
- Ubuntu (x86_64 / amd64) - Link zum Herunterladen von Docker Desktop
- Debian (x86_64 / amd64) - Link zum Herunterladen von Docker Desktop
- Fedora (x86_64 / amd64) - Link zum Herunterladen von Docker Desktop
- Red Hat Enterprise Linux (x86_64 / amd64) - Link zum Herunterladen von Docker Desktop
Schritt-für-Schritt-Anleitung
1. Docker Desktop installieren
Wenn Sie Docker Desktop noch nicht installiert haben, folgen Sie diesen Schritten:
Gehen Sie zur Docker Desktop-Downloadseite.
Laden Sie das Installationsprogramm für Docker Desktop für Linux herunter.
Führen Sie das Installationsprogramm aus und folgen Sie den Anweisungen auf dem Bildschirm.
- 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:latest3. Den Container ohne Zertifikat ausführen
Starten Sie den Docker-Container mit den erforderlichen Umgebungsvariablen: 
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latestAnwenden eines Test- oder Lizenzschlüssels zum Entfernen von Wasserzeichen
Tipps
<IRONSECUREDOC_LICENSE_KEY> mit Ihrem tatsächlichen IronSecureDoc-Lizenzschlüssel. Andernfalls wird ein Wasserzeichen auf die Unternehmensfunktionen angewendet. 
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
Sie 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:
- Zertifikat erstellen:
dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
dotnet dev-certs https --trustErsetzen Sie <CREDENTIAL_PLACEHOLDER> durch ein Passwort.
- Führen Sie den Docker-Container aus:
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:latestErsetzen Sie <IRONSECUREDOC_LICENSE_KEY> und <CERTIFICATE_PASSWORD> durch Ihren tatsächlichen IronSecureDoc-Lizenzschlüssel und Ihr Zertifikatspasswort.
6. Verwaltung des Containers
Sie können Ihren laufenden Container mit Docker-Befehlen verwalten. Hier sind einige nützliche Befehle:
- Container stoppen:
docker stop ironsecuredoc- Starten Sie den Container:
docker start ironsecuredoc- Entfernen Sie den Container:
docker rm -f ironsecuredocUmgebungsvariablen
Der Container kann mit den 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(Standard: 5): Legt die Zeitüberschreitung in Sekunden für API-Anfragen fest. Bei einem Wert von -1 können die Anfragen unbegrenzt laufen.ALLOWED_ORIGINS: Konfiguriert das Cross-Origin Resource Sharing (CORS), indem zugelassene Ursprungs-URLs angegeben werden. 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 freigibt. Dies sollte der Portzuordnung mit dem -p-Flag entsprechen (z. B. 8080). Trennen Sie mehrere Ports mit einem Semikolon (;).HTTPS_PORTS: Definiert die HTTPS-Ports, die der Container freigibt. Dies sollte mit der Port-Zuordnung mithilfe des -p Flags übereinstimmen (z.B. 8081). Trennen Sie mehrere Ports 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
Für die vollständige Liste der API-Endpunkte siehe die vollständige REST-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'Ersetze /path/to/your/document.pdf durch den tatsächlichen Pfad zu dem Dokument, das du schwärzen möchtest, und sensitiveWord durch das Wort, das du schwärzen möchtest.
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 des Dokuments, das Sie schwärzen möchten, und [0-9] durch den regulären Ausdruck, den Sie abgleichen und schwärzen möchten.
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. Für weitere Konfigurations- und Nutzungsdetails beachten Sie bitte das vollständige REST API Reference.
