Host IronSecureDoc on Mac with C# API

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.

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

Gereksinimler

UyarıDocker, macOS'un en güncel sürümlerinde Docker Desktop'ı destekler. Yani, macOS'un güncel sürümü ve önceki iki sürümü. Yeni macOS ana sürümleri genel kullanıma sunuldukça, Docker en eski sürümü desteklemeyi durdurur ve (önceki iki sürüme ek olarak) macOS'un en yeni sürümünü desteklemeye başlar.

Intel çipli Mac

Apple silikonlu Mac

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. Mac 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 satırı arayüzü açın ve Docker Hub'dan en son IronSecureDoc görüntüsünü çekin:

# Pull the latest IronSecureDoc image
docker pull ironsoftwareofficial/ironsecuredoc:latest
# Pull the latest IronSecureDoc image
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:

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

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

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

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:

    # 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

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

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

    # 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

    <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_or_name>
    docker stop <container_id_or_name>
    SHELL
  • Kapsayıcıyı başlat:

    docker start <container_id_or_name>
    docker start <container_id_or_name>
    SHELL
  • Kapsayıcıyı kaldır:

    docker rm -f <container_id_or_name>
    docker rm -f <container_id_or_name>
    SHELL

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 bağlantı noktası 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

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

# 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'
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, cURL kullanarak IronSecureDoc REST API'si ile hem temel hem de ileri düzey işlemlerle nasıl etkileşimde bulunulacağını öğ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

macOS'ta IronSecureDoc konteynerini barındırmak için hangi adımlar gereklidir?

macOS'ta IronSecureDoc konteynerini barındırmak için, Docker Desktop'u yüklemeniz, en son IronSecureDoc Docker imajını çekmeniz ve IronSecureDoc_LicenseKey, PDF_MAX_SIZE_MB ve REQUEST_TIMEOUT_SECONDS gibi ortam değişkenlerini yapılandırmanız gerekmektedir. Detaylı talimatlar eğitimde verilmektedir.

Bir Mac'te HTTPS desteğiyle IronSecureDoc konteynerini nasıl çalıştırabilirim?

Mac'te IronSecureDoc konteynerini HTTPS ile çalıştırmak için dotnet dev-certs kullanarak bir sertifika oluşturun, ardından sertifika yolları ve şifreleri belirterek ortam değişkenleri için -v ve -e içeren uygun komutla konteyneri çalıştırın.

Docker konteyneri macOS'ta çalışırken IronSecureDoc arayüzüne nasıl erişebilirim?

Docker konteyneri macOS'ta çalışırken, web tarayıcınızdan http://localhost:8080/swagger/index.html adresine giderek IronSecureDoc arayüzüne erişebilirsiniz.

macOS'ta Docker Desktop'u yüklemek için ön koşullar nelerdir?

macOS'ta Docker Desktop'u yüklemek için, Mac'iniz desteklenen bir macOS sürümünü çalıştırıyor olmalıdır; bu, güncel sürüm ve önceki iki sürümü içerir. Ayrıca, işlemcinize uygun yükleyiciyi seçtiğinizden emin olun, Intel veya Apple Silicon.

IronSecureDoc Docker konteynerini kullanarak bir PDF içinde kelimeleri veya desenleri nasıl karartabilirim?

PDF içinde kelimeleri veya desenleri karartmak için cURL gibi araçlar kullanarak IronSecureDoc API uç noktasına POST isteği gönderin, PDF dosyasını ve karartılacak kelimeleri veya desenleri belirleyin.

macOS'ta IronSecureDoc konteyneri için hangi ortam değişkenleri ayarlanabilir?

IronSecureDoc konteyneri için ortam değişkenleri PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS ve IronSecureDoc_LicenseKey içerir.

macOS'ta en son IronSecureDoc Docker imajını nasıl çekerim?

macOS'ta en son IronSecureDoc Docker imajını çekmek için terminalinizde şu komutu çalıştırın: docker pull ironsoftwareofficial/ironsecuredoc:latest.

Mac'te IronSecureDoc konteynerini yönetmek için temel Docker komutları nelerdir?

Mac'te IronSecureDoc konteynerini yönetmek için temel Docker komutları docker stop, docker start ve docker rm -f içerir.

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.