Hosting IronSecureDoc on Linux Using C

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

IronSecureDoc to kontener Docker zaprojektowany, aby zapewnić potężną manipulację plikami PDF za pomocą prostego REST API, bez kłopotów i obciążeń związanych z usługami SaaS online. Ten przewodnik przeprowadzi cię krok po kroku przez proces hostowania IronSecureDoc na twoim komputerze, w tym konfigurowanie zmiennych środowiskowych oraz podstawowy przykład użycia REST API. Dla pełnej dokumentacji API, zapoznaj się z naszym Dokumentacja API REST.

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

Wymagania wstępne

OstrzeżenieDocker Desktop na Linuxie uruchamia maszynę wirtualną (VM), która tworzy i używa niestandardowego kontekstu dockera, desktop-linux, podczas uruchamiania.

Oznacza to, że obrazy i kontenery wdrożone na maszynie Docker Engine Linux (przed instalacją) nie są dostępne w Docker Desktop dla Linux.

Platformy

Przewodnik krok po kroku

1. Zainstaluj Docker Desktop

Jeśli jeszcze nie zainstalowałeś Docker Desktop, wykonaj następujące kroki:

  1. Przejdź na stronę pobierania Docker Desktop.
  2. Pobierz instalator Docker Desktop dla Linux.
  3. Uruchom instalator i postępuj zgodnie z instrukcjami wyświetlanymi na ekranie.
  4. Po instalacji, uruchom Docker Desktop i upewnij się, że działa.

2. Pobierz obraz Docker "IronSecureDoc"

Otwórz wiersz poleceń i pobierz najnowszy obraz IronSecureDoc z Docker Hub:

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

3. Uruchom kontener bez certyfikatu

Uruchom kontener Docker z niezbędnymi zmiennymi środowiskowymi:

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

Zastosuj klucz licencyjny Trial lub pełny, aby usunąć znaki wodne

Porady
Zamień <IRONSECUREDOC_LICENSE_KEY> na swój rzeczywisty klucz licencyjny IronSecureDoc. W przeciwnym razie, na funkcjach Enterprise zostanie zastosowany znak wodny.

Swagger UI in Browser

)}]

4. Uzyskaj dostęp do kontenera

Gdy kontener działa, możesz uzyskać dostęp do IronSecureDoc, otwierając przeglądarkę internetową i przechodząc do:

http://localhost:8080/swagger/index.html
Swagger UI in Browser

Powinno wyświetlić się interfejs IronSecureDoc, wskazując, że twój kontener działa pomyślnie.

5. Uruchom kontener IronSecureDoc z certyfikatem

Jeśli potrzebujesz uruchomić kontener z certyfikatem, wykonaj te kroki, aby wygenerować certyfikat i skonfigurować lokalny komputer:

  1. Wygeneruj certyfikat:

    dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
    dotnet dev-certs https --trust
    dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
    dotnet dev-certs https --trust
    SHELL

    Zamień <CREDENTIAL_PLACEHOLDER> na hasło.

  2. Uruchom kontener Docker:

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

    Zamień <IRONSECUREDOC_LICENSE_KEY> i <CERTIFICATE_PASSWORD> na swój rzeczywisty klucz licencyjny IronSecureDoc i hasło do certyfikatu.

6. Zarządzanie kontenerem

Możesz zarządzać działającym kontenerem za pomocą poleceń Docker. Oto kilka przydatnych poleceń:

  • Zatrzymaj kontener:

    docker stop <container_id>
    docker stop <container_id>
    SHELL
  • Uruchom kontener:

    docker start <container_id>
    docker start <container_id>
    SHELL
  • Usuń kontener:

    docker rm -f <container_id>
    docker rm -f <container_id>
    SHELL

Zamień <container_id> na rzeczywisty identyfikator lub nazwę kontenera.

Zmienne środowiskowe

Kontener można skonfigurować za pomocą następujących zmiennych środowiskowych:

  • PDF_MAX_SIZE_MB (Domyślnie: 30): Ustawia maksymalny dozwolony rozmiar pliku do przesłania PDF w megabajtach.
  • REQUEST_TIMEOUT_SECONDS (Domyślnie: 5): Ustawia czas oczekiwania w sekundach na żądania API. Wartość -1 pozwala na nieograniczone przetwarzanie żądań.
  • ALLOWED_ORIGINS: Konfiguruje współdzielenie zasobów pomiędzy różnymi źródłami (CORS) poprzez określenie dozwolonych adresów URL. Oddziel wielokrotne adresy URL przecinkami. Użyj * lub "all", aby zezwolić na żądania z dowolnego miejsca.
  • HTTP_PORTS: Definiuje porty HTTP, które kontener wystawia. Powinno to odpowiadać mapowaniu portów wykorzystując flagę -p (np. 8080). Oddziel wielokrotne porty średnikiem (;).
  • HTTPS_PORTS: Definiuje porty HTTPS, które kontener wystawia. Powinno to odpowiadać mapowaniu portów wykorzystując flagę -p (np. 8081). Oddziel wielokrotne porty średnikiem (;).
  • IronSecureDoc_LicenseKey (Wymagane): Ustawia klucz licencyjny IronSecureDoc. Ważne: Nie udostępniaj tej wartości publicznie.

Podstawowy przykład: Redagowanie tekstu w dokumencie

Dla pełnej listy punktów końcowych API, zapoznaj się z pełnym Dokumentacja API REST.

Redagowanie tekstu

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

Zamień /path/to/your/document.pdf na rzeczywistą ścieżkę do dokumentu, który chcesz zredagować oraz sensitiveWord na słowo, które chcesz zredagować.

Redagowanie wyrażeń regularnych

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

Zamień /path/to/your/document.pdf na rzeczywistą ścieżkę do dokumentu, który chcesz zredagować oraz [0-9] na wyrażenie regularne, które chcesz dopasować i zredagować.

Wnioski

Pomyślnie hostowałeś IronSecureDoc na swoim komputerze i skonfigurowałeś go za pomocą niezbędnych zmiennych środowiskowych. Nauczyłeś się również, jak korzystać z REST API IronSecureDoc przy użyciu cURL zarówno dla operacji podstawowych, jak i zaawansowanych. Dla dalszych szczegółów konfiguracji i użytkowania zapoznaj się z pełnym Dokumentacja API REST.

Często Zadawane Pytania

Czym jest IronSecureDoc i jak działa?

IronSecureDoc to kontener Docker oferujący zaawansowaną manipulację PDF za pośrednictwem REST API, umożliwiający offline'owe zabezpieczenie dokumentów bez polegania na usługach SaaS.

Jakie są wymagania dotyczące konfiguracji IronSecureDoc na serwerze Linux?

Aby skonfigurować IronSecureDoc na serwerze Linux, upewnij się, że Docker Desktop jest zainstalowany na twojej dystrybucji Linux, takiej jak Ubuntu, Debian, Fedora lub Red Hat Enterprise Linux.

Jak mogę pobrać obraz kontenera Docker IronSecureDoc?

Pobierz obraz Docker IronSecureDoc, wykonując polecenie: docker pull ironsoftwareofficial/ironsecuredoc:latest w terminalu.

Czy można uruchomić kontener IronSecureDoc bez certyfikatu SSL?

Tak, można uruchomić kontener bez certyfikatu SSL, używając polecenia: docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey= -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest.

Jak mogę uzyskać dostęp do interfejsu IronSecureDoc w mojej przeglądarce?

Po uruchomieniu kontenera uzyskaj dostęp do interfejsu IronSecureDoc, odwiedzając http://localhost:8080/swagger/index.html w przeglądarce.

Jak wygenerować i zaufać certyfikatowi SSL dla IronSecureDoc?

Wygeneruj certyfikat SSL, używając: dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p i zaufaj mu, używając: dotnet dev-certs https --trust.

Jakie zmienne środowiskowe są dostępne do konfiguracji w IronSecureDoc?

Konfigurowalne zmienne środowiskowe w IronSecureDoc to PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS i IronSecureDoc_LicenseKey.

Jak mogę zaciemnić tekst w PDF przy użyciu IronSecureDoc?

Zaciemnij tekst w PDF, używając polecenia cURL: curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' z wymaganymi danymi formularza.

Jakiego polecenia użyć, aby zatrzymać działający kontener Docker IronSecureDoc?

Zatrzymaj działający kontener Docker, używając polecenia: docker stop .

Gdzie mogę znaleźć pełną listę punktów końcowych API dla IronSecureDoc?

Pełna lista punktów końcowych API dostępna jest w Dokumentacji API REST na stronie IronSecureDoc.

Curtis Chau
Autor tekstów technicznych

Curtis Chau posiada tytuł licencjata z informatyki (Uniwersytet Carleton) i specjalizuje się w front-endowym rozwoju, z ekspertką w Node.js, TypeScript, JavaScript i React. Pasjonuje się tworzeniem intuicyjnych i estetycznie przyjemnych interfejsów użytkownika, Curtis cieszy się pracą z nowoczesnymi frameworkami i tworzeniem dobrze zorganizowanych, atrakcyjnych wizualnie podrę...

Czytaj więcej
Gotowy, aby rozpocząć?
Wersja: 2024.10 just released
Still Scrolling Icon

Wciąż przewijasz?

Czy chcesz szybko dowodu?
uruchom przykład zobacz, jak twój PDF staje się zaszyfrowany.