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

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

Ön Koşullar

UyarıDocker, en son macOS sürümlerinde Docker Desktop'u destekler. Yani, macOS'un mevcut sürümü ve önceki iki sürümü. macOS'un yeni büyük sürümleri genel kullanıma sunulduğunda, Docker en eski sürümü desteklemeyi durdurur ve en yeni macOS sürümünü desteklemeye başlar (önceki iki sürümle birlikte).

Intel çipli Mac

Apple silikonlu Mac

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

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 Konteyneri Çalıştırın

Gerekli ortam değişkenleriyle Docker konteynerini ç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

Gerçek IronSecureDoc lisans anahtarınızla <IRONSECUREDOC_LICENSE_KEY> değiştirin. Aksi takdirde, Enterprise Özelliklerinde bir filigran uygulanacaktır.

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

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:

    # 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> yerine bir şifre girin.

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

    # 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

    İpuçları Gerçek IronSecureDoc lisans anahtarınız ve sertifika şifrenizle sırasıyla <IRONSECUREDOC_LICENSE_KEY> ve <CERTIFICATE_PASSWORD> 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_or_name>
    docker stop <container_id_or_name>
    SHELL
  • Konteyneri başlat:

    docker start <container_id_or_name>
    docker start <container_id_or_name>
    SHELL
  • Konteyneri kaldır:

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

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 Kaynağı Paylaşımını (CORS) yapılandırır. Birden fazla URL'yi virgülle ayırın. * veya all kullanarak herhangi bir kaynaktan gelen isteklere izin verin.
  • HTTP_PORTS: Kapsayıcının açığa çıkardığı HTTP portlarını tanımlar. Bu, -p bayrağını kullanarak bağlantı noktası eşlemesiyle eşleşmelidir (örneğin, 8080). Birden fazla portu noktalı virgül (;) ile ayırın.
  • HTTPS_PORTS: Kapsayıcının açığa çıkardığı HTTPS portlarını tanımlar. Bu, -p bayrağını kullanarak bağlantı noktası eşlemesiyle eşleşmelidir (örneğin, 8081). Birden fazla portu noktalı virgül (;) ile 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

# 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

İflah etmeyi istediğiniz belgenin gerçek yoluyla /path/to/your/document.pdf'ı ve iflah etmek istediğiniz kelimeyle sensitiveWord değiştirin.

Düzenli İfade Kapat

# 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

İflah etmeyi istediğiniz belgenin gerçek yoluyla /path/to/your/document.pdf'ı ve eşleştirip iflah etmek istediğiniz düzenli ifadeyle [0-9] 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 konteynerini macOS'ta barındırmak için hangi adımlar gereklidir?

IronSecureDoc konteynerini macOS'ta barındırmak için Docker Desktop'u yüklemeniz, en son IronSecureDoc Docker görüntüsünü çekmeniz ve IronSecureDoc_LicenseKey, PDF_MAX_SIZE_MB ve REQUEST_TIMEOUT_SECONDS gibi çevre değişkenleriyle konteyneri yapılandırmanız gerekir. Ayrıntılı talimatlar eğitimde sunulmuştur.

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

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

Docker konteyneri macOS'ta çalıştığında IronSecureDoc arayüzüne nasıl erişirim?

Docker konteyneri macOS'ta çalıştığında, web tarayıcınızda http://localhost:8080/swagger/index.html'u ziyaret ederek IronSecureDoc arayüzüne erişebilirsiniz.

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

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

IronSecureDoc Docker konteyneri kullanarak bir PDF'de kelime veya kalıpları nasıl redakte edebilirim?

Bir PDF'deki kelime veya kalıpları redakte edebilmek için PDF dosyası ve redakte edilecek kelime veya kalıpları belirterek IronSecureDoc API uç noktasına cURL gibi araçlar kullanarak bir POST isteği gönderin.

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

IronSecureDoc konteyneri için ortam değişkenleri arasında PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS ve IronSecureDoc_LicenseKey bulunur.

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

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

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

IronSecureDoc konteynerini yönetmek için bazı 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 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.