1. IronSecureDoc
  2. Tutoriels
  3. Hébergement et mise en place d'Azure

Hébergement sous Windows

This article was translated from English: Does it need improvement?
Translated
View the article in English

IronSecureDoc sur DockerIronSecureDoc est un conteneur Docker conçu pour vous offrir une manipulation puissante des PDF derrière une simple API REST, sans les tracas et les frais généraux des services SaaS en ligne. Ce guide vous guidera à travers les étapes pour héberger IronSecureDoc sur votre machine, y compris la configuration des variables d'environnement et un exemple de base d'utilisation de l'API REST. Pour obtenir l'API complète, consultez notre Référence de l'API REST

docker pull ironsoftwareofficial/ironsecuredoc:latest

Conditions préalables

Guide étape par étape

1. Installer Docker Desktop

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

  1. Aller à la page 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 fonctionne.

2. Extraire l'image Docker "IronSecureDoc"

Ouvrez une invite de commande et tirez la dernière image IronSecureDoc depuis Docker Hub :

docker pull ironsoftwareofficial/ironsecuredoc:latest

3. Exécuter le conteneur sans certificat

Exécutez le conteneur Docker avec les variables d'environnement nécessaires : Swagger UI dans le navigateur

docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest

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

[{t :(Remplacez <IRONSECUREDOC_LICENSE_KEY> par votre clé de licence IronSecureDoc. Dans le cas contraire, un filigrane sera appliqué sur les caractéristiques de l'entreprise. Swagger UI dans le navigateur)}]

4. Accéder au conteneur

Une fois le conteneur en marche, vous pouvez accéder à IronSecureDoc en ouvrant un navigateur web et en naviguant vers :


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

Swagger UI dans le navigateurVous devriez voir l'interface IronSecureDoc, indiquant que votre conteneur fonctionne correctement.

5. Exécuter le conteneur IronSecureDoc avec un 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

Remplacez <CREDENTIAL_PLACEHOLDER> par un mot de passe.

  1. Exécuter 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

Remplacez <IRONSECUREDOC_LICENSE_KEY> et <CERTIFICATE_PASSWORD> par votre clé de licence IronSecureDoc et votre mot de passe de 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 ironsecuredoc
  • Démarrer le conteneur :
  docker start ironsecuredoc
  • Retirer le conteneur :
  docker rm -f ironsecuredoc

Variables d'environnement

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

  • PDF_MAX_SIZE_MB (TAILLE MAXIMALE) (TAILLE MAXIMALE) (Valeur par défaut : 30): Définit la taille maximale autorisée pour les téléchargements de fichiers PDF en mégaoctets.
  • REQUEST_TIMEOUT_SECONDS (Valeur par défaut : 5): Définit le délai d'attente en secondes pour les demandes d'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és. Séparez les URL multiples par des virgules. Utilisez * ou all pour autoriser les demandes provenant de n'importe quelle origine.
  • HTTP_PORTS : Définit les ports HTTP auxquels le conteneur est exposé. Cela doit correspondre au mappage des ports en utilisant le drapeau -p (par exemple, 8080). Séparer plusieurs ports par un point-virgule (;).
  • HTTPS_PORTS : Définit les ports HTTPS auxquels le conteneur est exposé. Cela doit correspondre au mappage des ports en utilisant le drapeau -p (par exemple, 8081). Séparer plusieurs ports par un point-virgule (;).
  • IronSecureDoc_LicenseKey (Exigée): Définit la clé de licence IronSecureDoc. Important : Ne partagez pas cette valeur publiquement.

Exemple de base : Expurger du texte dans un document

Pour obtenir la liste complète des points de terminaison de l'API, consultez le document complet Référence de l'API REST.

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

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

Réduire l'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'

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

Conclusion

Vous avez réussi à héberger IronSecureDoc sur votre machine et à le configurer avec les variables d'environnement nécessaires. Vous avez également appris à interagir avec l'API REST d'IronSecureDoc à l'aide de cURL pour les opérations de base et avancées. Pour plus de détails sur la configuration et l'utilisation, voir le document complet Référence de l'API REST.