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, güçlü PDF manipülasyonu sunan basit bir REST API'ye sahip Docker kapsayıcısıdır. Bu kılavuz, ortam değişkenlerini ayarlama ve REST API'yi kullanmanın temel bir örneği de dahil olmak üzere, IronSecureDoc'u makinenizde barındırma adımlarını size anlatacaktır. Tam API için, REST API Referansı sayfamızı görüntüleyin

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

Gereksinimler

Adım Adım Kılavuz

1. Docker Desktop'ı Kurun

Docker Desktop'ı henüz kurmadıysanız, bu adımları takip edin:

  1. Docker Desktop indirme sayfasına gidin.
  2. Windows için Docker Desktop kurulum dosyasını indirin.
  3. Kurulum dosyasını çalıştırın ve ekrandaki yönergeleri izleyin.
  4. Kurulumdan sonra, Docker Desktop'ı başlatın ve çalıştığından emin olun.

2. 'IronSecureDoc' Docker Görüntüsünü Çekin

Bir komut istemi 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 Kapsayıcıyı Çalıştırın

Gerekli ortam değişkenleriyle Docker kapsayıcısını ç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

Filigranları Kaldırmak İçin Deneme veya Lisans Anahtarı Uygula

İpuçları<IRONSECUREDOC_LICENSE_KEY> kısmını gerçek IronSecureDoc lisans anahtarınızla değiştirin. Aksi takdirde, Enterprise Özellikleri üzerinde bir filigran uygulanacaktır.

Swagger UI in Browser

4. Kapsayıcıya Erişim

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

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

Kapsayıcınızın başarıyla çalıştığını gösteren IronSecureDoc arayüzünü görmelisiniz.

5. Sertifikalı IronSecureDoc Kapsayıcısını Çalıştırın

Kapsayıcıyı bir sertifikalı çalıştırmanız gerekiyorsa, sertifikayı oluşturma ve yerel makineyi yapılandırma adımlarını 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> ifadesini bir şifre ile değiştirin.

  2. Docker Kapsayıcısını Çalıştır:

    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> yerlerini sırasıyla gerçek IronSecureDoc lisans anahtarınız ve sertifika şifrenizle değiştirin.

6. Kapsayıcıyı Yönetme

Docker komutlarını kullanarak çalışan kapsayıcınızı yönetebilirsiniz. İşte birkaç faydalı komut:

  • Kapsayıcıyı durdur:

    docker stop <container-id>
    docker stop <container-id>
    SHELL
  • Kapsayıcıyı başlat:

    docker start <container-id>
    docker start <container-id>
    SHELL
  • Kapsayıcıyı kaldır:

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

<container-id> ifadesini gerçek konteyner kimliği veya adıyla değiştirin.

Ortam Değişkenleri

Kapsayıcı 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 olarak çalışmasına izin verir.
  • ALLOWED_ORIGINS: İzin verilen kaynak URL'lerini belirterek Kaynaklar Arası Paylaşım (CORS) yapılandırır. Birden çok URL'yi virgülle ayırın. Herhangi bir kaynaktan gelen istekleri kabul etmek için * veya all kullanın.
  • HTTP_PORTS: Konteynerin açığa çıkardığı HTTP bağlantı noktalarını tanımlar. Bu, -p bayrağını (ör. 8080) kullanarak port eşlemesiyle eşleşmelidir. Birden fazla bağlantı noktasını noktalı virgülle ayırın (;).
  • HTTPS_PORTS: Konteynerin açığa çıkardığı HTTPS bağlantı noktalarını tanımlar. Bu, -p bayrağını (ör. 8081) kullanarak bağlantı noktası eşleşmesiyle uyumlu olmalıdır. Birden fazla bağlantı noktasını 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 Belgede Metni Karartma

Tüm API uç noktalarının tam listesini görmek için tam REST API Referansına bakın.

Metni Karart

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'yi sansürlemek istediğiniz belgenin gerçek yoluyla ve sensitiveWord'yi sansürlemek istediğiniz WORD kelimeyle değiştirin.

Düzenli İfade Karart

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'yi, sansürlemek istediğiniz belgenin gerçek yoluyla ve [0-9]'yi, eşleştirmek ve sansürlemek istediğiniz düzenli ifadeyle 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 cURL kullanarak IronSecureDoc REST API ile nasıl etkileşim kurulacağını da öğrendiniz. Daha fazla yapılandırma ve kullanım ayrıntıları için tam REST API Referansına bakın.

Sıkça Sorulan Sorular

IronSecureDoc nedir?

IronSecureDoc, çevrimdışı belge güvenliği ve uyumluluğu için tasarlanmış, basit bir REST API üzerinden güçlü PDF manipülasyonu sunan bir Docker konteyneridir.

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

IronSecureDoc'u Windows'ta barındırmak için Windows 10 veya daha yeni bir sürüme ya da Windows Server sürümüne (2016, 2019, 2022) ve Docker Desktop for Windows kurulu olmasına ihtiyacınız var.

Windows makinemde Docker Desktop'u nasıl kurabilirim?

Resmi Docker web sitesinden Docker Desktop'u indirin, yükleyiciyi çalıştırın ve yükleme talimatlarını izleyin. Yükleme tamamlandıktan sonra, kullanmaya başlamak için Docker Desktop'u başlatın.

IronSecureDoc Docker imajını nasıl indirebilirim?

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

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

Evet,licans anahtarınızı gerçek anahtarınızla değiştirerek şu 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.

Konteyner çalışırken IronSecureDoc arayüzüne nasıl erişebilirim?

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

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

dotnet dev-certs kullanarak bir sertifika oluşturun ve ardından güvenliği artırmak için sertifika yolu ve şifresi içeren komutla IronSecureDoc konteynerini çalıştırın.

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

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 kullanarak bir PDF'te hassas bilgileri nasıl karartabilirim?

Bir PDF'te metin karartmak için PDF dosyasını ve karartılması gereken metni veya deseni belirterek IronSecureDoc REST API'ye POST isteği göndermek için bir cURL komutu kullanın.

IronSecureDoc REST API için detaylı dokümantasyonu 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 (Carleton Üniversitesi) sahip ve Node.js, TypeScript, JavaScript ve React konularında uzmanlaşmış ön uç geliştirmeyle ilgileniyor. Sezgisel ve estetik açıdan hoş kullanıcı arayüzleri oluşturma tutkunu, Curtis modern çerçevelerle çalışmayı ve iyi yapı...

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

Hâlâ Kaydırıyor Musunuz?

Hızlıca kanıt ister misiniz?
bir örnek çalıştırın PDF'nizin şifrelenmesini izleyin.