Host IronSecureDoc on Mac with C# API

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 Mac.
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 interfejs wiersza poleceń i pobierz najnowszy obraz IronSecureDoc z Docker Hub:

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

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

3. Uruchom kontener bez certyfikatu

Uruchom kontener Docker z niezbędnymi zmiennymi środowiskowymi:

# 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

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

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

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

5. Uruchom kontener IronSecureDoc z certyfikatem

Jeśli musisz uruchomić kontener z certyfikatem, postępuj zgodnie z tymi krokami, aby wygenerować certyfikat i skonfigurować lokalny komputer:

1. Wygeneruj certyfikat:

   # 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

   Zamień <CREDENTIAL_PLACEHOLDER> na hasło.

2. Uruchom kontener Docker:

   # 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
   PoradyZamień <IRONSECUREDOC_LICENSE_KEY> i <CERTIFICATE_PASSWORD> na swój rzeczywisty klucz licencyjny IronSecureDoc i hasło certyfikatu odpowiednio.

6. Zarządzanie kontenerem

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

• Zatrzymaj kontener:

  docker stop <container_id_or_name>

  docker stop <container_id_or_name>

  SHELL

• Uruchom kontener:

  docker start <container_id_or_name>

  docker start <container_id_or_name>

  SHELL

• Usuń kontener:

  docker rm -f <container_id_or_name>

  docker rm -f <container_id_or_name>

  SHELL

Redagowanie tekstu

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

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

Redagowanie wyrażeń regularnych

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

Zamień /path/to/your/document.pdf na rzeczywistą ścieżkę do dokumentu, który chcesz zredagować, a [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.