Hosting IronSecureDoc on Linux Using C#
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 .
docker pull ironsoftwareofficial/ironsecuredoc:latestPrérequis
desktop-linux, au démarrage.Cela signifie que les images et les conteneurs déployés sur le moteur Docker Linux (avant installation) ne sont pas disponibles dans Docker Desktop pour Linux.
Plateformes
- Ubuntu (x86_64 / amd64) - lien pour télécharger Docker Desktop
- Debian (x86_64 / amd64) - lien pour télécharger Docker Desktop
- Fedora (x86_64 / amd64) - Lien de téléchargement de Docker Desktop Red Hat Enterprise Linux (x86_64 / amd64) - Lien de téléchargement de Docker Desktop
Guide étape par étape
1. Installez Docker Desktop
Si vous n'avez pas encore installé Docker Desktop, procédez comme suit :
- Rendez-vous sur la page de téléchargement de Docker Desktop .
- Téléchargez le programme d'installation de Docker Desktop pour Linux.
- Exécutez le programme d'installation et suivez les instructions à l'écran.
- 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:latest3. Exécuter le conteneur sans certificat
Exécutez le conteneur Docker avec les variables d'environnement nécessaires :
docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latestUtilisez une clé d'essai ou de licence pour supprimer les filigranes
Remplacez <IRONSECUREDOC_LICENSE_KEY> par votre 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
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 :
-
Générer un certificat :
dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> dotnet dev-certs https --trustSHELLRemplacez
<CREDENTIAL_PLACEHOLDER>par un mot de passe. -
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 $HOME/.aspnet/https:/https:ro \ -e CERTIFICATE_PATH=$HOME/.aspnet/https/ironsecuredoc.pfx \ -e CERTIFICATE_PASSWORD=<CERTIFICATE_PASSWORD> \ ironsoftwareofficial/ironsecuredoc:latestSHELLRemplacez
<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 <container_id>SHELL -
Démarrer le conteneur :
docker start <container_id>SHELL -
Retirez le conteneur :
docker rm -f <container_id>SHELL
Remplacez <container_id> par l'ID 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'expiration 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 le drapeau-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 le 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
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 d'accès réel du document que vous souhaitez expurger et sensitiveWord par le mot que vous souhaitez expurger.
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'Remplacez /path/to/your/document.pdf par le chemin d'accès réel du 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 qu'IronSecureDoc et comment cela fonctionne-t-il?
IronSecureDoc est un conteneur Docker offrant une puissante manipulation de PDF via une API REST, permettant une sécurité des documents hors ligne sans dépendre de services SaaS.
Quelles sont les exigences pour configurer IronSecureDoc sur un serveur Linux?
Pour configurer IronSecureDoc sur un serveur Linux, assurez-vous que Docker Desktop est installé sur votre distribution Linux, telle qu'Ubuntu, Debian, Fedora ou Red Hat Enterprise Linux.
Comment puis-je télécharger l'image Docker d'IronSecureDoc?
Téléchargez l'image Docker d'IronSecureDoc en exécutant la commande: docker pull ironsoftwareofficial/ironsecuredoc:latest dans votre terminal.
Est-il possible d'exécuter le conteneur IronSecureDoc sans certificat SSL?
Oui, vous pouvez exécuter le conteneur sans certificat SSL en utilisant la commande: docker container run --rm -p 8080:8080 -e IronSecureDoc_LicenseKey=<IRONSECUREDOC_LICENSE_KEY> -e ENVIRONMENT=Development -e HTTP_PORTS=8080 ironsoftwareofficial/ironsecuredoc:latest.
Comment puis-je accéder à l'interface IronSecureDoc sur mon navigateur?
Après avoir démarré le conteneur, accédez à l'interface IronSecureDoc en visitant http://localhost:8080/swagger/index.html dans votre navigateur web.
Comment générer et faire confiance à un certificat SSL pour IronSecureDoc?
Générez un certificat SSL en utilisant: dotnet dev-certs https -ep $HOME/.aspnet/https/ironsecuredoc.pfx -p <CREDENTIAL_PLACEHOLDER> et faites-lui confiance avec: dotnet dev-certs https --trust.
Quelles variables d'environnement sont disponibles pour la configuration dans IronSecureDoc?
Les variables d'environnement configurables dans IronSecureDoc comprennent PDF_MAX_SIZE_MB, REQUEST_TIMEOUT_SECONDS, ALLOWED_ORIGINS, HTTP_PORTS, HTTPS_PORTS, et IronSecureDoc_LicenseKey.
Comment puis-je expurger le texte dans un PDF en utilisant IronSecureDoc?
Expurgez le texte dans un PDF en utilisant une commande cURL: curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' avec les données de formulaire requises.
Quelle commande dois-je utiliser pour arrêter un conteneur Docker IronSecureDoc en cours d'exécution?
Arrêtez un conteneur Docker en cours d'exécution en utilisant la commande: docker stop <container_id>.
Où puis-je trouver une liste complète des points de terminaison API pour IronSecureDoc?
La liste complète des points de terminaison API est disponible dans la référence de l'API REST sur le site web d'IronSecureDoc.
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.
