Pièces jointes de la documentation - Archyl Docs

Ajoutez des images et des fichiers à vos pages de documentation par glisser-déposer, collage ou bouton joindre — stockés en toute sécurité dans un stockage objet compatible S3

Pièces jointes de la documentation

Joignez des images et des fichiers directement à n'importe quelle page de documentation. Déposez une capture d'écran dans l'éditeur et elle s'intègre dans le contenu ; joignez un PDF, une spécification ou une archive et elle apparaît sous forme de carte téléchargeable. Les fichiers sont conservés dans un stockage objet — sans jamais alourdir votre base de données — et suivent la page partout où elle est consultée ou partagée.

Ajouter des pièces jointes

Ouvrez une page de documentation dans l'éditeur (Nouveau doc ou Modifier) et ajoutez des fichiers de la manière la plus rapide :

  • Glissez-déposez un ou plusieurs fichiers dans l'éditeur
  • Collez une image directement depuis le presse-papiers (par ex. une capture d'écran)
  • Cliquez sur Joindre un fichier dans la barre d'outils de l'éditeur et sélectionnez vos fichiers

Vous pouvez joindre plusieurs fichiers à la fois. Un nouveau document est enregistré automatiquement dès le premier ajout de fichier, pour ne jamais perdre un téléversement.

Images et autres fichiers

Archyl traite les deux cas comme on s'y attend :

  • Les images sont intégrées dans le contenu Markdown à l'endroit où vous les ajoutez, afin de s'afficher directement dans la page.
  • Les autres fichiers (PDF, documents, archives, …) sont ajoutés au panneau Pièces jointes sous forme de cartes téléchargeables plutôt que d'être insérés dans le texte.

Consulter les pièces jointes

À la lecture d'une page, les pièces jointes apparaissent dans un panneau Pièces jointes en haut du document, juste sous le titre — les lecteurs voient ainsi ce qui est disponible avant même de faire défiler la page. Chaque fichier affiche :

  • Une icône de type colorée, ou une miniature pour les images
  • Le nom, le type et la taille du fichier
  • Une action de téléchargement en un clic

Les images s'affichent également dans le contenu, là où vous les avez placées.

Gérer les pièces jointes

Depuis l'éditeur, le panneau Pièces jointes permet de :

  • Télécharger n'importe quel fichier
  • Supprimer un fichier (avec une confirmation rapide en ligne) — ce qui le retire aussi du stockage

Supprimer un document supprime également ses pièces jointes.

Fichiers pris en charge

Vous pouvez joindre tout type de fichier. Les images sont intégrées dans le contenu ; tout le reste apparaît sous forme de carte téléchargeable. Exemples courants :

  • Images — PNG, JPEG, GIF, WebP, SVG, AVIF
  • Documents — PDF, Word, Excel, PowerPoint, texte brut, Markdown, CSV
  • Données et archives — JSON, YAML, ZIP, journaux

La taille maximale par défaut est de 10 Mo par fichier (configurable sur les instances auto-hébergées).

Astuce : Si votre navigateur ne reconnaît pas un type de fichier, celui-ci est tout de même accepté et proposé au téléchargement.

Stockage et confidentialité

Les pièces jointes sont conservées dans un stockage objet plutôt que dans la base de données de l'application. Sur Archyl Cloud, ce stockage est Google Cloud Storage — géré pour vous, sans rien à configurer. Sur les instances auto-hébergées, vous choisissez votre propre fournisseur compatible S3 (voir ci-dessous).

Dans tous les cas :

  • Le bucket est privé. Les fichiers sont servis via des liens signés à courte durée de vie générés à la demande — les objets sous-jacents ne sont jamais listables publiquement.
  • Les liens intégrés dans une page restent stables : la documentation partagée et publique continue de fonctionner sans exposer le bucket.
  • Le chiffrement au repos est actif par défaut. Google Cloud Storage chiffre chaque objet automatiquement ; sur les instances auto-hébergées, vous pouvez aussi fournir vos propres clés (par exemple une CMEK Cloud KMS sur GCS).

Pour les instances auto-hébergées

Sur Archyl Cloud, les pièces jointes fonctionnent immédiatement. Si vous auto-hébergez, vous apportez votre propre stockage objet — et vous pouvez pointer Archyl vers n'importe quel fournisseur compatible S3 (Google Cloud Storage, Amazon S3, MinIO, Cloudflare R2, …).

Tant que le stockage n'est pas configuré, l'action Joindre un fichier est indisponible et les téléversements renvoient un message clair « Le stockage de fichiers n'est pas configuré ». Définissez les variables d'environnement STORAGE_* sur le backend (endpoint, bucket, clé d'accès, clé secrète) pour activer la fonctionnalité ; pour Google Cloud Storage, utilisez l'endpoint d'interopérabilité (HMAC). Consultez la configuration de votre déploiement pour la liste complète des options.

Étapes suivantes