Cover Image

LOGXMAS 2025 #21 - Organisez vos documents comme un pro avec Bookstack

Retours personnels

J'utilise BookStack depuis plusieurs années déjà et il me permet d'avoir mes documents textes simples, ou même un peu plus complexes, partout et tout le temps. Quand on vient d'un monde dicté par les éditeurs de texte tel que Word, il faut se préparer à un changement drastique dans la rédaction puisque les outils proposés par la barre d'édition sont beaucoup plus simples et très peu nombreux en comparaison. Néanmoins, il y a plusieurs points à retenir :

  • Vous pouvez toujours modifier le code source de votre page si vous utilisez le mode WYSIWYG (What You See Is What You Get), ce code est en HTML et avec quelques recherches vous trouverez le moyen d'effectuer le style que vous souhaitez.
  • Si vous utilisez déjà le Markdown au quotidien, foncez, vous ne serez pas perdu avec le mode d'édition Markdown.
  • La communauté et les Hack proposés vous permettront de personnaliser votre instance BookStack pour correspondre le mieux à vos besoins et vos habitudes. Par exemple, j'ai rajouté le module pour transformer les formules que j'écris en LaTeX pour qu'elle s'affiche comme elle se doit plutôt qu'écrire "x^2".

En bref, vous gagnerez du temps dans la rédaction de vos documents, croyez moi 😊

Un des autres points que j'apprécie énormément et que j'utilise tout le temps est le système de permission très bien conçu (des fois même un peu trop granulaire 😂) qui va vous permettre de partager proprement vos documents sans risquer les mauvaises manipulations.

Un dernier point si vous aimez mettre les mains dans le code, littéralement, en effet, BookStack propose un grand niveau de personnalisation si vous maîtrisez les langages web (HTML/PHP/CSS). J'ai personnellement modifié certains affichages pour que certains éléments ne s'affichent que pour les membres connectés.

Description de l'outil

BookStack est un outil de stockage et gestion d'informations de manière hiérarchisée. Il est conçu pour les équipes, les organisations ou encore les particuliers souhaitant maintenir une documentation centralisée, simple d'utilisation et avec des fonctionnalités de recherche, très pratiques quand il faut retrouver des documents.

Caractéristiques majeures de l'outil

  • Gestion de la documentation structurée : Organisez vos documents dans une structure hiérarchique à plusieurs niveaux, facilitant la recherche et la navigation.
  • Intégration de modules complémentaires : BookStack appelle cela les Hacks, ils permettent d'ajouter des fonctionnalités très intéressantes à votre espace documentaire comme l'utilisation du TeX/LaTeX pour des formules mathématiques lisibles.
  • Sécurité : Protégez votre contenu avec un système d'authentification centralisé. De plus, la gestion des droits pour accéder, modifier ou encore commenter les documents est très fine et vous permettra d'autoriser les bonnes personnes pour les bons documents.
  • Editeur de documents : Modifiez très facilement et avec un certain style vos documents grâce à plusieurs éditeurs, notamment un éditeur en Markdown.

Exemple d'utilisation

Imaginons une équipe de développeurs qui souhaite documenter son code, ses processus... de manière plus cadrée que certaines instructions dans le code. Elle pourra mettre en place l'outil BookStack comme décrit dans les étapes juste après :

  1. Installation et configuration : Téléchargez et installez BookStack sur votre serveur local (par exemple, un VPS ou un Raspberry Pi) et configurez le comme décrit dans la documentation.
  2. Ajout de la documentation : Ajoutez vos documents déjà existants dans votre architecture documentaire souhaitée en fonction des équipes, utilisations...
  3. Mise en place des ACL : Créez vos utilisateurs, fédérez votre authentification avec votre SSO si besoin, vos rôles pour correspondre au mieux à l'organisation de vos équipes et des accès que chacun doit avoir et ne pas avoir.

Avec BookStack, cette équipe pourra documenter ses processus, son code, ses actions... très simplement pour collaborer encore plus efficacement.

Et vous ? Est-ce que vous utilisez déjà cet outil ? Souhaiteriez-vous le mettre en place personnellement ou professionnellement ? N'hésitez pas à commenter pour échanger sur le sujet. 

Currently there are no comments, so be the first!