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

Hébergement sur Linux

Chaknith Bin

juillet 20, 2024

Mise à jour novembre 19, 2024

Partager:

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

docker pull ironsoftwareofficial/ironsecuredoc:latest

Conditions préalables

docker pull 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

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

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

2. 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êter le conteneur :

  docker stop ironsecuredoc

• Démarrer le conteneur :

  docker start ironsecuredoc

• Supprimer 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 (Par défaut : 30) : Définit la taille maximale autorisée pour les fichiers PDF téléchargés en mégaoctets.
• REQUEST_TIMEOUT_SECONDS (Par défaut : 5) : Définit la durée de temporisation 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 cross-origin (CORS) en spécifiant les URL d'origine autorisées. 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 exposés par le conteneur. Cela devrait correspondre au mapping de port en utilisant le drapeau -p (par exemple, 8080). Séparer plusieurs ports par un point-virgule (;).
• HTTPS_PORTS : Définit les ports HTTPS exposés par le conteneur. Cela devrait correspondre au mapping de port en utilisant le drapeau -p (par exemple, 8081). Séparer plusieurs ports par un point-virgule (;).
• IronSecureDoc_LicenseKey (Obligatoire) : Définit la clé de licence IronSecureDoc. Important : Ne partagez pas cette valeur publiquement.

Exemple de base : Expurger du texte dans un document

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

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 souhaitez modifier et [0-9] par l'expression régulière que vous souhaitez trouver et modifier.

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

Chaknith Bin

  Discutez avec l'équipe d'ingénierie maintenant

Ingénieur logiciel

Chaknith travaille sur IronXL et IronBarcode. Il possède une expertise approfondie en C# et .NET, aidant à améliorer le logiciel et à soutenir les clients. Ses idées issues des interactions avec les utilisateurs contribuent à de meilleurs produits, une documentation améliorée et une expérience globale enrichie.