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

Comment héberger IronSecureDoc sur Windows avec 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'API complète, veuillez vous référer à notre documentation de référence de l'API REST.

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

Prérequis

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 Windows.
  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 invite de commandes et téléchargez la dernière image IronSecureDoc depuis Docker Hub :

docker pull ironsoftwareofficial/ironsecuredoc:latest
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 :

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

Utilisez une clé d'essai ou de licence pour supprimer les filigranes

ConseilsRemplacer<IRONSECUREDOC_LICENSE_KEY> avec votre clé de licence IronSecureDoc réelle. Sinon, un filigrane sera appliqué aux fonctionnalités Entreprise.@@--BRACKET-FERME--@@

Swagger UI in Browser

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
Swagger UI in Browser

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 :

    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

    Remplacer<CREDENTIAL_PLACEHOLDER> avec un mot de passe.

  2. Exécutez le conteneur Docker :

    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

    Remplacer<IRONSECUREDOC_LICENSE_KEY> et<CERTIFICATE_PASSWORD> avec votre clé de licence IronSecureDoc et votre mot de passe de certificat respectifs.

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>
    docker stop <container-id>
    SHELL

  • Démarrer le conteneur :

    docker start <container-id>
    docker start <container-id>
    SHELL

  • Retirez le conteneur :

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

Remplacer<container-id> avec l'identifiant ou le nom réel du conteneur.

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. La valeur -1 permet aux requêtes de s'exécuter 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. Cela doit correspondre au mappage de port utilisant l'option -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. Cela doit correspondre au mappage de port utilisant l'option -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

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

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

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

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

Qu'est-ce que IronSecureDoc ?

IronSecureDoc est un conteneur Docker qui offre une manipulation PDF puissante via une API REST simple, spécialement conçue pour la sécurité et la conformité des documents hors ligne.

Quelles sont les exigences système pour héberger IronSecureDoc sur Windows?

Pour héberger IronSecureDoc sur Windows, vous avez besoin de Windows 10 ou plus récent, ou d'une version de Windows Server (2016, 2019, 2022) et Docker Desktop pour Windows installé.

Comment puis-je installer Docker Desktop sur ma machine Windows?

Téléchargez Docker Desktop depuis le site officiel de Docker, lancez l'installateur et suivez les instructions d'installation. Une fois installé, démarrez Docker Desktop pour commencer à l'utiliser.

Comment télécharger l'image Docker IronSecureDoc?

Ouvrez votre invite de commande et exécutez la commande : docker pull ironsoftwareofficial/ironsecuredoc:latest pour télécharger l'image IronSecureDoc.

Est-il possible d'exécuter IronSecureDoc sans certificat SSL?

Oui, vous pouvez exécuter le conteneur IronSecureDoc sans certificat SSL en exécutant la commande : docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey= -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest, en remplaçant par votre clé de licence réelle.

Comment accéder à l'interface IronSecureDoc une fois le conteneur en cours d'exécution?

Vous pouvez accéder à l'interface IronSecureDoc en ouvrant un navigateur web et en naviguant vers http://localhost:8080/swagger/index.html.

Comment configurer IronSecureDoc avec un certificat SSL?

Générez un certificat en utilisant dotnet dev-certs puis exécutez le conteneur IronSecureDoc avec la commande qui inclut le chemin du certificat et le mot de passe pour une sécurité renforcée.

Quelles variables d'environnement sont disponibles pour configurer le conteneur IronSecureDoc?

Vous pouvez configurer diverses variables d'environnement telles que PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS, et IronSecureDoc_LicenseKey.

Comment masquer des informations sensibles dans un PDF avec IronSecureDoc?

Pour masquer du texte dans un PDF, utilisez une commande cURL pour envoyer une requête POST à l'API REST IronSecureDoc, en spécifiant le fichier PDF et le texte ou le motif à masquer.

Où puis-je trouver une documentation détaillée pour l'API REST IronSecureDoc?

La référence complète de l'API REST pour IronSecureDoc est disponible à /enterprise/securedoc/tutorials/use-rest-api/.

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