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

Curtis Chau
Curtis Chau
Mis à jour : 2 août 2026
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 l'API complète, consultez notre Référence de l'API REST.

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

Prérequis

Avertissement: 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. Lorsque de nouvelles versions majeures de macOS sont généralement disponibles, Docker cesse de prendre en charge la version la plus ancienne et prend en charge la nouvelle version de macOS (en plus des deux versions précédentes).

Mac avec puce Intel

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

Remplacez <IRONSECUREDOC_LICENSE_KEY> par votre véritable clé de licence IronSecureDoc. 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
Text

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

Remplacez <CREDENTIAL_PLACEHOLDER> par un mot de passe.

  1. 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
    SHELL
Conseils: Remplacez <IRONSECUREDOC_LICENSE_KEY> et <CERTIFICATE_PASSWORD> par votre véritable clé de licence IronSecureDoc et mot de passe du certificat respectivement.

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êtez le conteneur :

    docker stop <container_id_or_name>
    SHELL
  • Démarrez le conteneur :

    docker start <container_id_or_name>
    SHELL
  • Supprimez le conteneur :

    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 (Défaut : 30) : Définit la taille maximale autorisée pour les téléchargements de fichiers PDF en mégaoctets.
  • REQUEST_TIMEOUT_SECONDS (Défaut : 5) : Définit la durée d'expiration en secondes pour les requêtes API. Une valeur de -1 permet aux requêtes de s’exécuter indéfiniment.
  • ALLOWED_ORIGINS : Configure le partage de ressources Cross-Origin (CORS) en spécifiant les URLs d'origine autorisées. Séparez les URL multiples par des virgules. Utilisez * ou all pour autoriser les requêtes de n'importe quelle origine.
  • HTTP_PORTS : Définit les ports HTTP exposés par le conteneur. Cela doit correspondre au mappage des ports en utilisant le drapeau -p (par exemple, 8080). Séparez plusieurs ports par un point-virgule (;).
  • HTTPS_PORTS : Définit les ports HTTPS exposés par le conteneur. Cela doit correspondre au mappage des ports en utilisant le drapeau -p (par exemple, 8081). Séparez plusieurs ports par un point-virgule (;).
  • IronSecureDoc_LicenseKey (Requis) : Définit la clé de licence IronSecureDoc. Important : Ne divulguez pas cette valeur publiquement.

Exemple simple : Supprimer du texte dans un document

Pour la liste complète des points d'API, consultez la Référence de l'API REST complète.

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

Remplacez /path/to/your/document.pdf par le chemin réel du document que vous souhaitez modifier et sensitiveWord par le mot que vous souhaitez modifier.

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

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

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, consultez la Référence de l'API REST complète.

Questions fréquemment posées

Comment puis-je exécuter IronSecureDoc sur mon Mac ?

Pour exécuter IronSecureDoc sur un Mac, assurez-vous que Docker Desktop est installé et en cours d'exécution. Vous pouvez ensuite télécharger l'image Docker d'IronSecureDoc et l'exécuter avec les variables d'environnement nécessaires.

Quelles sont les conditions préalables pour héberger IronSecureDoc sur un Mac ?

Avant d'héberger IronSecureDoc sur un Mac, vous devez avoir Docker Desktop installé et en cours d'exécution sur votre système, compatible avec les Macs Intel et Apple Silicon.

Comment puis-je accéder au conteneur IronSecureDoc une fois qu'il est en cours d'exécution ?

Vous pouvez accéder au conteneur IronSecureDoc en naviguant vers 'http://localhost:8080/swagger/index.html' dans un navigateur web, où vous verrez l'interface IronSecureDoc.

Comment exécuter le conteneur IronSecureDoc avec un certificat ?

Pour utiliser un certificat, générez un certificat de développement HTTPS avec 'dotnet dev-certs https'. Ensuite, exécutez le conteneur Docker avec les variables d'environnement appropriées, y compris les chemins vers le certificat et son mot de passe.

Quelles sont les variables d'environnement qui peuvent être configurées dans IronSecureDoc ?

Les variables d'environnement configurables dans IronSecureDoc incluent PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS, et IronSecureDoc_LicenseKey.

Comment puis-je expurger du texte dans un PDF en utilisant IronSecureDoc ?

Vous pouvez expurger du texte en envoyant une requête POST à l'API IronSecureDoc avec le document et les paramètres pour le texte à expurger en utilisant curl.

Quel est le but du conteneur IronSecureDoc ?

Le conteneur IronSecureDoc offre une sécurité et une conformité des documents hors ligne via une API REST puissante pour la manipulation de PDF, réduisant la dépendance aux services SaaS en ligne.

IronSecureDoc peut-il gérer l'expurgation de PDF en utilisant des expressions régulières ?

Oui, IronSecureDoc prend en charge l'expurgation de texte PDF en utilisant des expressions régulières via ses points d'extrémité API REST, permettant le retrait ciblé de contenu.

Que devez-vous faire si le conteneur doit prendre en charge HTTPS ?

Générez un certificat HTTPS, faites-lui confiance en utilisant 'dotnet dev-certs', et exécutez le conteneur Docker en utilisant des variables d'environnement pour spécifier le chemin et le mot de passe du certificat.

Où puis-je trouver la liste complète des points d'extrémité API REST pour IronSecureDoc ?

La liste complète des points d'extrémité API REST pour IronSecureDoc se trouve dans la référence API REST disponible dans la documentation.

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 et créer des manuels bien structurés et visuellement attrayants.

Lire la suite

Prêt à commencer ?

Version :2024.10tout juste publié