How to Host IronSecureDoc on Windows with C
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. Aby uzyskać pełną Dokumentacja API, przejdź do REST API Reference
docker pull ironsoftwareofficial/ironsecuredoc:latest
docker pull ironsoftwareofficial/ironsecuredoc:latest
Wymagania wstępne
- System operacyjny Windows
- Windows 10 lub nowszy
- Windows Server (2016, 2019, 2022) Uwaga: może wymagać dodatkowych kroków
- Programy
- Docker Desktop for Windows zainstalowany i uruchomiony
Przewodnik krok po kroku
1. Zainstaluj Docker Desktop
Jeśli jeszcze nie zainstalowałeś Docker Desktop, wykonaj następujące kroki:
- Przejdź na stronę pobierania Docker Desktop.
- Pobierz instalator Docker Desktop dla Windows.
- Uruchom instalator i postępuj zgodnie z instrukcjami wyświetlanymi na ekranie.
- 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
3. Uruchom kontener bez certyfikatu
Uruchom kontener Docker z niezbędnymi zmiennymi środowiskowymi:
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
Zastosuj klucz licencyjny Trial lub pełny, aby usunąć znaki wodne
<IRONSECUREDOC_LICENSE_KEY> swoim faktycznym kluczem licencyjnym IronSecureDoc. W przeciwnym razie na funkcjach Enterprise zostanie nałożony 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:
-
Wygeneruj certyfikat:
dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> dotnet dev-certs https --trustdotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> dotnet dev-certs https --trustSHELLZastąp
<CREDENTIAL_PLACEHOLDER>hasłem. -
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 %USERPROFILE%\.aspnet\https:/https:ro -e CERTIFICATE_PATH=%USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> ironsoftwareofficial/ironsecuredoc:latestdocker 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:latestSHELLZastąp
<IRONSECUREDOC_LICENSE_KEY>i<CERTIFICATE_PASSWORD>odpowiednio swoim faktycznym kluczem licencyjnym IronSecureDoc i hasłem do certyfikatu.
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>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
Zastąp <container-id> faktycznym ID lub nazwą kontenera.
Zmienne środowiskowe
Kontener można skonfigurować przy użyciu następujących zmiennych środowiskowych:
PDF_MAX_SIZE_MB(Domyślnie: 30): Ustawia maksymalny dozwolony rozmiar pliku dla przesyłania PDF w megabajtach.REQUEST_TIMEOUT_SECONDS(Domyślnie: 5): Ustawia czas trwania limitu czasu dla żądań API w sekundach. Wartość-1pozwala na wykonywanie żądań bez końca.ALLOWED_ORIGINS: Konfiguruje Cross-Origin Resource Sharing (CORS) poprzez określenie dozwolonych URL źródeł. Oddziel wielokrotne adresy URL przecinkami. Użyj*luball, aby pozwolić na żądania z dowolnego źródła.HTTP_PORTS: Definiuje porty HTTP, które kontener udostępnia. To powinno odpowiadać mapowaniu portów przy użyciu flagi-p(np.8080). Oddziel wiele portów średnikiem (;).HTTPS_PORTS: Definiuje porty HTTPS, które kontener udostępnia. To powinno odpowiadać mapowaniu portów przy użyciu flagi-p(np.8081). Oddziel wiele portów ś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'
Zastąp /path/to/your/document.pdf rzeczywistą ścieżką do dokumentu, który chcesz ukryć i sensitiveWord słowem, które chcesz ukryć.
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'
Zastąp /path/to/your/document.pdf rzeczywistą ścieżką do dokumentu, który chcesz ukryć, a [0-9] wyrażeniem regularnym, które chcesz dopasować i ukryć.
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?
IronSecureDoc to kontener Docker, który oferuje zaawansowaną manipulację PDF poprzez prosty REST API, zaprojektowany specjalnie dla bezpieczeństwa i zgodności dokumentów offline.
Jakie są wymagania systemowe do hostowania IronSecureDoc na Windows?
Aby hostować IronSecureDoc na Windows, potrzebujesz Windows 10 lub nowszego, lub wersji Windows Server (2016, 2019, 2022) oraz zainstalowanego Docker Desktop dla Windows.
Jak mogę zainstalować Docker Desktop na moim komputerze z Windows?
Pobierz Docker Desktop z oficjalnej strony Docker, uruchom instalator i postępuj zgodnie z instrukcjami instalacji. Po zainstalowaniu uruchom Docker Desktop, aby rozpocząć jego używanie.
Jak mogę pobrać obraz Docker IronSecureDoc?
Otwórz swój wiersz poleceń i wykonaj polecenie: docker pull ironsoftwareofficial/ironsecuredoc:latest, aby pobrać obraz IronSecureDoc.
Czy można uruchomić IronSecureDoc bez certyfikatu SSL?
Tak, możesz uruchomić kontener IronSecureDoc bez certyfikatu SSL, wykonując polecenie: docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=, zastępując
Jak mogę uzyskać dostęp do interfejsu IronSecureDoc, gdy kontener jest uruchomiony?
Możesz uzyskać dostęp do interfejsu IronSecureDoc, otwierając przeglądarkę internetową i przechodząc do http://localhost:8080/swagger/index.html.
Jak skonfigurować IronSecureDoc z certyfikatem SSL?
Wygeneruj certyfikat za pomocą dotnet dev-certs, a następnie uruchom kontener IronSecureDoc z poleceniem, które zawiera ścieżkę do certyfikatu i hasło dla zwiększonego bezpieczeństwa.
Jakie zmienne środowiskowe są dostępne do konfiguracji kontenera IronSecureDoc?
Możesz skonfigurować różne zmienne środowiskowe, takie jak PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS i IronSecureDoc_LicenseKey.
Jak mogę wymazać poufne informacje w PDF za pomocą IronSecureDoc?
Aby wymazać tekst w PDF, użyj polecenia cURL, aby wysłać żądanie POST do IronSecureDoc REST API, określając plik PDF oraz tekst lub wzorzec do wymazania.
Gdzie mogę znaleźć szczegółową dokumentację dla IronSecureDoc REST API?
Pełna dokumentacja REST API dla IronSecureDoc jest dostępna pod adresem /enterprise/securedoc/tutorials/use-rest-api/.

