How to Host IronSecureDoc on Windows with C

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

IronSecureDoc, çevrimiçi SaaS hizmetlerinin zahmeti ve yükü olmadan, basit bir REST API'nin arkasında size güçlü PDF manipülasyonu sağlamak üzere tasarlanmış bir Docker konteyneridir. Bu kılavuz, ortam değişkenlerini ayarlama ve REST API'yi kullanmaya yönelik temel bir örnek dahil olmak üzere IronSecureDoc'u makinenize barındırma adımlarında size yol gösterecektir. Tam API için, REST API Referansı'mıza bakın.

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

Ön Koşullar

Adım Adım Kılavuz

1. Docker Desktop'u Yükleme

Docker Desktop'u henüz yüklemediyseniz, şu adımları izleyin:

  1. Docker Desktop indirme sayfasına gidin.
  2. Windows için Docker Desktop yükleyicisini indirin.
  3. Yükleyiciyi çalıştırın ve ekrandaki talimatları izleyin.
  4. Yüklemeden sonra Docker Desktop'u başlatın ve çalıştığından emin olun.

2. "IronSecureDoc" Docker Görüntüsünü Çek

Komut istemcisini açın ve Docker Hub'dan en son IronSecureDoc görüntüsünü çekin:

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

3. Sertifikasız Konteyneri Çalıştırın

Gerekli ortam değişkenleriyle Docker konteynerini çalıştırın:

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

Watermarkları Kaldırmak İçin Deneme veya Lisans Anahtarı Uygulayın

[{t: (Gerçek IronSecureDoc lisans anahtarınızı <IRONSECUREDOC_LICENSE_KEY> ile değiştirin. Aksi takdirde, Enterprise Özelliklerinde bir filigran uygulanacaktır.)}]

Swagger UI in Browser

4. Konteynere Erişin

Konteyner çalıştığında, bir web tarayıcısı açarak ve şuraya giderek IronSecureDoc'a erişebilirsiniz:

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

Konteynerin başarılı bir şekilde çalıştığını gösteren IronSecureDoc arayüzünü görmelisiniz.

5. IronSecureDoc Konteynerini Sertifikalı Çalıştırın

Sertifika ile konteyner çalıştırmanız gerekiyorsa, sertifikayı oluşturmak ve yerel makineyi yapılandırmak için bu adımları izleyin:

  1. Sertifika Oluştur:

    dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
    dotnet dev-certs https --trust
    dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER>
    dotnet dev-certs https --trust
    SHELL

    <CREDENTIAL_PLACEHOLDER> ile bir şifre değiştirin.

  2. Docker Konteynerini Çalıştırın:

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

    <IRONSECUREDOC_LICENSE_KEY> ve <CERTIFICATE_PASSWORD> ile sırasıyla gerçek IronSecureDoc lisans anahtarınızı ve sertifika şifrenizi değiştirin.

6. Konteyneri Yönetme

Çalışan konteynerinizi Docker komutlarını kullanarak yönetebilirsiniz. İşte birkaç yararlı komut:

  • Konteyneri durdur:

    docker stop <container-id>
    docker stop <container-id>
    SHELL
  • Konteyneri başlat:

    docker start <container-id>
    docker start <container-id>
    SHELL
  • Konteyneri kaldır:

    docker rm -f <container-id>
    docker rm -f <container-id>
    SHELL

Gerçek kapsayıcı kimliği veya adını <container-id> ile değiştirin.

Ortam Değişkenleri

Konteyner aşağıdaki ortam değişkenleri kullanılarak yapılandırılabilir:

  • PDF_MAX_SIZE_MB (Varsayılan: 30): PDF yüklemeleri için izin verilen maksimum dosya boyutunu Megabayt cinsinden ayarlar.
  • REQUEST_TIMEOUT_SECONDS (Varsayılan: 5): API istekleri için zaman aşımı süresini saniye cinsinden ayarlar. -1 değeri, isteklerin süresiz çalışmasına izin verir.
  • ALLOWED_ORIGINS: İzin verilen kaynak URL'lerini belirterek Çapraz Kaynak Başvuru Paylaşımını (CORS) yapılandırır. Birden fazla URL'yi virgülle ayırın. Herhangi bir kaynaktan gelen istekleri izin vermek için * veya all kullanın.
  • HTTP_PORTS: Kapsayıcının açığa çıkardığı HTTP portlarını tanımlar. Bu, -p bayrağı kullanılarak yapılan port eşlemeleriyle eşleşmelidir (örn. 8080). Birden fazla portu noktalı virgülle (;) ayırın.
  • HTTPS_PORTS: Kapsayıcının açığa çıkardığı HTTPS portlarını tanımlar. Bu, -p bayrağı kullanılarak yapılan port eşlemeleriyle eşleşmelidir (örn. 8081). Birden fazla portu noktalı virgülle (;) ayırın.
  • IronSecureDoc_LicenseKey (Gerekli): IronSecureDoc lisans anahtarını ayarlar. Önemli: Bu değeri herkese açık olarak paylaşmayın.

Temel Örnek: Bir Belgedeki Metni Kapatın

API uç noktalarının tam listesi için REST API Referansı'na bakın.

Metni Kapat

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

/path/to/your/document.pdf ile sansürlemek istediğiniz belgenin gerçek yolunu ve sensitiveWord ile sansürlemek istediğiniz kelimeyi değiştirin.

Düzenli İfade Kapat

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

/path/to/your/document.pdf ile sansürlemek istediğiniz belgenin gerçek yolunu ve [0-9] ile eşleştirip sansürlemek istediğiniz düzenli ifadeyi değiştirin.

Sonuç

IronSecureDoc'u makinenizde başarıyla barındırdınız ve gerekli ortam değişkenleriyle yapılandırdınız. Ayrıca, hem temel hem de gelişmiş işlemler için IronSecureDoc REST API'si ile cURL kullanarak nasıl etkileşimde bulunacağınızı öğrendiniz. Daha fazla yapılandırma ve kullanım detayları için REST API Referansı'na bakın.

Sıkça Sorulan Sorular

IronSecureDoc nedir?

IronSecureDoc, basit bir REST API aracılığıyla güçlü PDF manipülasyonu sunan, offline belge güvenliği ve uyumluluğu için özel olarak tasarlanmış bir Docker konteyneridir.

IronSecureDoc'u Windows'ta barındırmak için sistem gereksinimleri nelerdir?

Windows'ta IronSecureDoc'u barındırmak için Windows 10 veya daha sonrası, ya da Windows Server sürümü (2016, 2019, 2022) ve Windows için Docker Desktop yüklü olması gereklidir.

Windows bilgisayarımda Docker Desktop'u nasıl yükleyebilirim?

Docker resmi web sitesinden Docker Desktop'u indirin, yükleyiciyi çalıştırın ve kurulum talimatlarını izleyin. Kurulum tamamlandıktan sonra Docker Desktop'u başlatın.

IronSecureDoc Docker imajını nasıl indirebilirim?

Komut istemcinizi açın ve IronSecureDoc imajını indirmek için docker pull ironsoftwareofficial/ironsecuredoc:latest komutunu çalıştırın.

IronSecureDoc'u SSL sertifikası olmadan çalıştırmak mümkün mü?

Evet, komutu çalıştırarak IronSecureDoc konteynerini SSL sertifikası olmadan çalıştırabilirsiniz: docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=-e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest,yerine gerçek lisans anahtarınızı koyun.

Konteyner çalıştığında IronSecureDoc arayüzüne nasıl erişebilirim?

Bir web tarayıcı açarak http://localhost:8080/swagger/index.html adresine giderek IronSecureDoc arayüzüne erişebilirsiniz.

IronSecureDoc'u bir SSL sertifikası ile nasıl yapılandırabilirim?

dotnet dev-certs kullanarak bir sertifika oluşturun ve ardından gelişmiş güvenlik için sertifika yolunu ve şifresini içeren komutla IronSecureDoc konteynerini çalıştırın.

IronSecureDoc konteynerini yapılandırmak için kullanılabilir hangi ortam değişkenleri var?

PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS ve IronSecureDoc_LicenseKey gibi çeşitli ortam değişkenlerini yapılandırabilirsiniz.

IronSecureDoc'u kullanarak bir PDF'deki hassas bilgileri nasıl redakte edebilirim?

Bir PDF'deki metni redakte etmek için PDF dosyası ve redakte edilecek metin veya kalıbı belirterek IronSecureDoc REST API'sine bir POST isteği göndermek için bir cURL komutu kullanın.

IronSecureDoc REST API için ayrıntılı belgeleri nerede bulabilirim?

IronSecureDoc için tam REST API Referansı /enterprise/securedoc/tutorials/use-rest-api/ adresinde mevcuttur.

Curtis Chau
Teknik Yazar

Curtis Chau, Bilgisayar Bilimleri alanında lisans derecesine sahiptir (Carleton Üniversitesi) ve Node.js, TypeScript, JavaScript ve React konularında uzmanlaşmış ön uç geliştirme üzerine uzmanlaşmıştır. Kullanıcı dostu ve estetik açıdan hoş arayüzler tasarlamaya tutkuyla bağlı olan Curtis, modern çerç...

Daha Fazlasını Oku
Başlamaya Hazır mısınız?
Sürüm: 2024.10 just released
Still Scrolling Icon

Hala Kaydiriyor musunuz?

Hızlı bir kanit mi istiyorsunuz?
bir örnek çalıştırın PDF'inizin şifrelenmiş hale gelmesini izleyin.