Documentez avec BookStack, une alternative open source à Confluence


  • FrançaisFrançais


  • BookStack est un système de documentation Web open source qui vous permet de créer un magasin de connaissances structuré pour une utilisation personnelle, en équipe ou en entreprise. BookStack se concentre sur la facilité d’utilisation et la conception pour offrir une expérience adaptée à un public ayant potentiellement des compétences mixtes en technologie. Il est construit sur le framework PHP Laravel, avec MySQL ou MariaDB utilisé comme magasin de données.

    J’ai construit BookStack après avoir tenté de trouver une documentation ou un système wiki pour mon lieu de travail. Confluence était l’option la plus proche pour répondre à mes besoins, mais la tarification basée sur l’utilisateur a introduit un obstacle. La nature fermée de Confluence a également soulevé des questions sur la longévité de la documentation que j’allais construire. Finalement, j’ai décidé de construire ma propre plateforme pour répondre à mes besoins. Je l’ai publié sous licence MIT pour redonner à la communauté open source que j’ai appris à aimer et dont j’ai bénéficié au fil des ans.

    Hiérarchie du contenu et options d’organisation

    Pour garder les choses familières et intuitives, BookStack utilise des termes de livre du monde réel pour décrire sa structure organisationnelle. Le contenu de la documentation est créé en tant que “Page”:

    • Les pages appartiennent à un “Livre” spécifique.
    • Au sein d’un livre, les pages peuvent éventuellement être regroupées en “chapitres”.
    • Au fur et à mesure que votre documentation s’agrandit, vous pouvez ensuite utiliser des “Étagères” pour catégoriser les Livres, les Livres pouvant faire partie de plusieurs étagères si nécessaire.

    Cette structure se trouve au cœur de BookStack et peut souvent être l’aspect déterminant de l’adéquation de BookStack à votre cas d’utilisation.

    Plus d’alternatives open source

    Sur cette hiérarchie de base, BookStack fournit également des fonctionnalités de marquage, de favoris des utilisateurs et de recherche avancée pour garantir que le contenu reste détectable.

    Rédaction de documents

    La principale méthode d’écriture de documentation dans BookStack consiste à utiliser son éditeur WYSIWYG (what-you-see-is-what-you-get), qui utilise l’open source Minuscule projet. Cet éditeur fournit une gamme de formats de contenu, notamment :

    • Différents niveaux d’en-tête
    • Blocs de code
    • Blocs pliables
    • les tables
    • Images
    • Liens
    • iFrame intègre
    • Appels d’alerte
    • Listes à puces, numérotées et tâches
    • Dessins (grâce à l’intégration avec l’open source diagrammes.net)

    Si vous préférez Markdown, vous pouvez utiliser l’éditeur Markdown intégré, qui fournit un aperçu en direct et prend en charge le même ensemble de fonctionnalités que l’éditeur WYSIWYG. Si l’autorisation le permet, vous pouvez même passer d’une option de l’éditeur à l’autre en fonction de la page que vous modifiez.

    Comment vos données sont stockées

    La documentation est stockée dans une base de données MySQL ou MariaDB dans un format HTML relativement simple, en plus du contenu original de Markdown si Markdown a été utilisé. De nombreuses décisions de conception et de développement ont été prises pour garder ce format HTML simpliste. Il utilise des éléments HTML standard simples dans la mesure du possible, pour garantir que le contenu de la documentation brute reste ouvert et portable.

    Les images téléchargées, les pièces jointes et les dessins créés sont enregistrés sur le système de fichiers local, mais peuvent éventuellement être stockés dans un magasin de données compatible s3 comme l’open source MinIO.

    Pour garder votre contenu accessible, il existe des options intégrées pour exporter le contenu au format PDF, HTML, texte brut ou Markdown. Pour la consommation externe, il existe une API HTTP REST et un système de webhook. En termes d’extension, un “système de thème logique” permet d’exécuter du code PHP personnalisé sur un large éventail d’événements système.

    Prêt pour les affaires

    BookStack est livré avec une gamme de fonctionnalités pour prendre en charge les environnements professionnels. La prise en charge d’une gamme d’options d’authentification est intégrée, notamment SAML2, OpenID Connect et LDAP, ce qui permet une utilisation facile de l’authentification unique avec des plates-formes telles que CléManteau. Des options MFA sont disponibles et peuvent être mandatées en fonction du rôle. Un journal d’audit offre une visibilité complète des activités de modification sur une instance.

    Un système d’autorisation complet basé sur les rôles offre aux administrateurs un contrôle total sur les actions de création, d’affichage, de mise à jour et de suppression du contenu du système. Cela permet des valeurs par défaut du système par rôle, avec des options pour définir des autorisations personnalisées sur une base par élément de hiérarchie.

    Une communauté de soutien

    Après avoir été active pendant plus de 7 ans, la communauté de BookStack s’est développée avec diverses avenues de discussion et de soutien. Nous avons maintenant :

    Si vous voulez jouer avec BookStack, vous pouvez l’essayer sur notre site de démonstration. Pour savoir comment configurer votre propre instance, visitez le page d’installation de notre documentation.

    Source

    N'oubliez pas de voter pour cet article !
    1 Star2 Stars3 Stars4 Stars5 Stars (No Ratings Yet)
    Loading...

    La Rédaction

    L'équipe rédactionnnelle du site

    Pour contacter personnellement le taulier :

    Laisser un commentaire

    Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *

    Copy code