1. IronSecureDoc
  2. Tutoriels
  3. Héberger sur Mac

Héberger IronSecureDoc sur Mac avec l'API C#

Curtis Chau
Curtis Chau
Mis à jour:
This article was translated from English: Does it need improvement?
Translated
View the article in English
IronSecureDoc on Docker

IronSecureDoc est un conteneur Docker conçu pour vous offrir une manipulation PDF puissante via une API REST simple, sans les tracas et la surcharge des services SaaS en ligne. Ce guide vous accompagnera pas à pas dans l'installation d'IronSecureDoc sur votre machine, y compris la configuration des variables d'environnement et un exemple simple d'utilisation de l'API REST. Pour consulter l'intégralité de l'API, veuillez vous référer à notre documentation de référence de l'API REST .

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

Prérequis

[{w:(Docker prend en charge Docker Desktop sur les versions les plus récentes de macOS. C'est-à-dire la version actuelle de macOS et les deux versions précédentes. À mesure que de nouvelles versions majeures de macOS sont mises à disposition du grand public, Docker cesse de prendre en charge la version la plus ancienne et prend en charge la version la plus récente de macOS (en plus des deux versions précédentes).

Mac avec puce Intel

Docker Desktop pour Mac avec processeur Intel installé et en cours d'exécution

Mac avec puce Apple

Guide étape par étape

1. Installez Docker Desktop

Si vous n'avez pas encore installé Docker Desktop, suivez ces étapes :

  1. Rendez-vous sur la page de téléchargement de Docker Desktop .
  2. Téléchargez le programme d'installation de Docker Desktop pour Mac.
  3. Exécutez le programme d'installation et suivez les instructions à l'écran.
  4. Après l'installation, démarrez Docker Desktop et assurez-vous qu'il est en cours d'exécution.

2. Extrayez l'image Docker " IronSecureDoc ".

Ouvrez une interface de ligne de commande et téléchargez la dernière image IronSecureDoc depuis Docker Hub :

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

3. Exécuter le conteneur sans certificat

Exécutez le conteneur Docker avec les variables d'environnement nécessaires :

# 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

Remplacer<IRONSECUREDOC_LICENSE_KEY> avec votre clé de licence IronSecureDoc réelle. Sinon, un filigrane sera apposé sur les fonctionnalités Entreprise.

4. Accédez au conteneur

Une fois le conteneur en cours d'exécution, vous pouvez accéder à IronSecureDoc en ouvrant un navigateur Web et en naviguant vers :

http://localhost:8080/swagger/index.html

Vous devriez voir l'interface IronSecureDoc, indiquant que votre conteneur fonctionne correctement.

5. Exécutez le conteneur IronSecureDoc avec le certificat

Si vous devez exécuter le conteneur avec un certificat, suivez ces étapes pour générer le certificat et configurer la machine locale :

  1. Générer un certificat :

    # 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

    Remplacer<CREDENTIAL_PLACEHOLDER> avec un mot de passe.

  2. Exécutez le conteneur Docker :

    # 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

    [{t:(Remplacer<IRONSECUREDOC_LICENSE_KEY> et<CERTIFICATE_PASSWORD> avec votre clé de licence IronSecureDoc et votre mot de passe de certificat respectifs.@@--BRACKET-FERME--@@

6. Gestion du conteneur

Vous pouvez gérer votre conteneur en cours d'exécution à l'aide des commandes Docker. Voici quelques commandes utiles :

  • Arrêter le conteneur :

    docker stop <container_id_or_name>
    docker stop <container_id_or_name>
    SHELL

  • Démarrer le conteneur :

    docker start <container_id_or_name>
    docker start <container_id_or_name>
    SHELL

  • Retirez le conteneur :

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

Variables environnementales

Le conteneur peut être configuré à l'aide des variables d'environnement suivantes :

  • PDF_MAX_SIZE_MB (Par défaut : 30) : Définit la taille maximale autorisée des fichiers PDF à télécharger en mégaoctets.
  • REQUEST_TIMEOUT_SECONDS (Par défaut : 5) : Définit la durée du délai d'attente en secondes pour les requêtes API. Une valeur de -1 permet aux demandes d'être exécutées indéfiniment.
  • ALLOWED_ORIGINS : Configure le partage de ressources entre origines (CORS) en spécifiant les URL d'origine autorisées. Séparez les URL multiples par des virgules. Utilisez * ou all pour autoriser les requêtes provenant de n'importe quelle origine.
  • HTTP_PORTS : Définit les ports HTTP exposés par le conteneur. Elle doit correspondre au mappage du port à l'aide de l'indicateur -p (par exemple, 8080). Séparez les ports multiples par un point-virgule ( ; ).
  • HTTPS_PORTS : Définit les ports HTTPS exposés par le conteneur. Elle doit correspondre au mappage du port à l'aide du drapeau -p (par exemple, 8081). Séparez les ports multiples par un point-virgule ( ; ).
  • IronSecureDoc_LicenseKey (Obligatoire) : Définit la clé de licence IronSecureDoc. Important : Ne divulguez pas cette valeur publiquement.

Exemple simple : Supprimer du texte dans un document

Pour obtenir la liste complète des points de terminaison de l'API, reportez-vous à la documentation complète de l'API REST .

Rétablir le texte

# 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

Remplacez /path/to/your/document.pdf par le chemin d'accès réel au document que vous souhaitez masquer et sensitiveWord par le mot que vous souhaitez masquer.

Rédiger une expression régulière

# 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

Remplacez /path/to/your/document.pdf par le chemin réel vers le document que vous souhaitez expurger et [0-9] par l'expression régulière que vous souhaitez faire correspondre et expurger.

Conclusion

Vous avez hébergé avec succès IronSecureDoc sur votre machine et l'avez configuré avec les variables d'environnement nécessaires. Vous avez également appris à interagir avec l'API REST d'IronSecureDoc en utilisant cURL pour les opérations de base et avancées. Pour plus de détails sur la configuration et l'utilisation, veuillez vous référer à la documentation complète de l'API REST .

Questions Fréquemment Posées

Quelles étapes sont nécessaires pour héberger le conteneur IronSecureDoc sur macOS ?

Pour héberger le conteneur IronSecureDoc sur macOS, vous devez installer Docker Desktop, télécharger la dernière image Docker IronSecureDoc, et configurer le conteneur avec des variables d'environnement telles que IronSecureDoc_LicenseKey, PDF_MAX_SIZE_MB, et REQUEST_TIMEOUT_SECONDS. Des instructions détaillées sont fournies dans le tutoriel.

Comment puis-je exécuter le conteneur IronSecureDoc avec le support HTTPS sur un Mac ?

Pour exécuter le conteneur IronSecureDoc avec HTTPS sur un Mac, générez un certificat en utilisant dotnet dev-certs, puis exécutez le conteneur avec la commande appropriée qui inclut -v pour le volume et -e pour les variables d'environnement, en spécifiant les chemins et mots de passe des certificats.

Comment puis-je accéder à l'interface IronSecureDoc une fois que le conteneur Docker est en cours d'exécution sur macOS ?

Une fois que le conteneur Docker est en cours d'exécution sur macOS, vous pouvez accéder à l'interface IronSecureDoc en visitant http://localhost:8080/swagger/index.html dans votre navigateur web.

Quelles sont les conditions préalables pour installer Docker Desktop sur macOS ?

Pour installer Docker Desktop sur macOS, assurez-vous que votre Mac fonctionne sur une version prise en charge de macOS, qui comprend la version actuelle et les deux versions précédentes. Assurez-vous également de sélectionner l'installateur compatible avec votre processeur, soit Intel, soit Apple Silicon.

Comment puis-je rédiger des mots ou des motifs dans un PDF en utilisant le conteneur Docker IronSecureDoc ?

Vous pouvez caviarder des mots ou des motifs dans un PDF en envoyant une demande POST au point de terminaison de l'API IronSecureDoc, en utilisant des outils comme cURL, en spécifiant le fichier PDF et les mots ou motifs à caviarder.

Quelles variables d'environnement peuvent être définies pour le conteneur IronSecureDoc sur macOS ?

Les variables d'environnement pour le conteneur IronSecureDoc incluent PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS, et IronSecureDoc_LicenseKey.

Comment puis-je télécharger la dernière image Docker IronSecureDoc sur macOS ?

Pour télécharger la dernière image Docker IronSecureDoc sur macOS, exécutez la commande : docker pull ironsoftwareofficial/ironsecuredoc:latest dans votre terminal.

Quels sont quelques commandes Docker de base pour gérer le conteneur IronSecureDoc sur Mac ?

Les commandes Docker de base pour gérer le conteneur IronSecureDoc incluent docker stop , docker start , et docker rm -f .

Curtis Chau
Curtis Chau
  Discutez maintenant avec l'équipe d'ingénierie
Rédacteur technique

Curtis Chau détient un baccalauréat en informatique (Université de Carleton) et se spécialise dans le développement front-end avec expertise en Node.js, TypeScript, JavaScript et React. Passionné par la création d'interfaces utilisateur intuitives et esthétiquement plaisantes, Curtis aime travailler avec des frameworks modernes ...

Lire la suite
Prêt à commencer?
Version : 2024.10 vient de sortir