Comment configurer Wiki.js et avoir votre propre wiki en quelques minutes

Configurer Wiki Js avec Docker

Wiki.js est une puissante plateforme de wiki open source construite sur Node.js. Elle prend en charge l’édition en Markdown et WYSIWYG, la collaboration en temps réel, le contrôle de version et des options d’authentification flexibles, y compris Google et LDAP. Dans ce guide, nous vous montrerons comment configurer Wiki.js avec Docker pour que vous puissiez mettre votre wiki en service en quelques minutes.

Installer Wiki.js en utilisant Docker Compose

Avec Docker et Docker Compose, il est incroyablement facile de configurer wiki.js. D’abord, créez un répertoire nommé “wikijs-docker” et accédez-y en utilisant la commande cd :

mkdir wikijs-docker && cd wikijs-docker  

Après cela, créez un fichier “docker-compose.yml” dans n’importe quel éditeur de texte :

nano docker-compose.yml  

Et ensuite, collez le contenu suivant dans ce fichier :

services:  

  db:  
    image: postgres:16  
    environment:  
      POSTGRES_DB: wiki  
      POSTGRES_PASSWORD: wikijsrocks  
      POSTGRES_USER: wikijs  
    restart: unless-stopped  
    volumes:  
      - db-data:/var/lib/postgresql/data  

  wiki:  
    image: ghcr.io/requarks/wiki:2  
    depends_on:  
      - db  
    environment:  
      DB_TYPE: postgres  
      DB_HOST: db  
      DB_PORT: 5432  
      DB_USER: wikijs  
      DB_PASS: wikijsrocks  
      DB_NAME: wiki  
    restart: unless-stopped  
    ports:  
      - "80:3000"  

volumes:  
  db-data:  

Enregistrez et fermez le fichier, puis démarrez les conteneurs en utilisant la commande suivante :

docker compose up -d  

Exécuter le conteneur Docker

Une fois la configuration terminée, ouvrez wiki.js dans votre navigateur à l’adresse http://localhost. Spécifiez les détails du compte administrateur et cliquez sur le bouton Installer pour commencer l’installation :

Démarrer l'installation de Wiki Js

Après l’installation, entrez vos identifiants pour vous connecter.

Créer et gérer des pages dans Wiki.js

Maintenant, vous pouvez créer la page d’accueil pour commencer à ajouter du contenu ou accéder au panneau d’administration pour gérer les paramètres, les utilisateurs et les fonctionnalités :

Page d'accueil Wiki Js

Si vous cliquez sur le bouton Créer la page d’accueil, on vous demandera de sélectionner un éditeur pour la page. Sélectionnez celui qui correspond à vos préférences et exigences :

Sélectionner l'éditeur

Spécifiez les propriétés de la page et cliquez sur le bouton OK pour créer une nouvelle page :

Définir les propriétés de la page

Écrivez ce que vous voulez et cliquez sur le bouton Créer pour créer la page :

Créer une page Wikijs

Gérer et organiser le contenu

Sur le tableau de bord, vous pouvez voir et éditer les pages existantes, créer de nouvelles pages en utilisant votre éditeur préféré, et organiser votre contenu en déplaçant, renommant ou supprimant des pages. Vous pouvez également ajouter des tags pour catégoriser le contenu efficacement. De plus, la barre latérale et la barre de recherche facilitent la navigation rapide vers des pages spécifiques de votre wiki :

Tableau de bord Wiki Js

Paramètres du site Wiki.js

Dans le panneau d’administration de Wiki.js, vous pouvez configurer les paramètres du site tels que la langue, la navigation, les thèmes et les tags. Ces options aident à définir la configuration globale de votre instance Wiki.js.

Vous pouvez configurer les paramètres de base de votre site dans l’onglet Général, tels que le titre du site, la description, la page d’accueil par défaut et la visibilité du site (publique ou privée) :

Paramètres généraux

Accédez à l’onglet Localisation pour définir la langue par défaut, le fuseau horaire et les formats de date/heure utilisés sur l’ensemble du site :

Définir la localisation

Pour gérer la structure des menus de votre wiki et contrôler comment les utilisateurs naviguent dans le contenu, allez dans la barre de Navigation.

Gérer la navigation du site

Dans l’onglet Pages, vous pouvez voir, gérer et organiser toutes les pages du wiki. Vous pouvez créer de nouvelles pages, modifier celles existantes ou gérer la hiérarchie des pages.

Gérer les pages

Vous pouvez également créer et gérer des tags de contenu sous l’onglet Tags pour aider à catégoriser les pages et améliorer la recherche. De même, vous pouvez modifier l’apparence et les sensations de votre wiki depuis l’onglet Thème. Par exemple, vous pouvez modifier le logo du site, les couleurs, les polices et les thèmes de mise en page.

Gérer le thème

Gérer les groupes sur votre wiki

Dans la section Groupes, vous pouvez créer des groupes d’utilisateurs, attribuer des membres et définir des autorisations au niveau du groupe pour contrôler l’accès. Utilisez les groupes pour organiser les utilisateurs par rôle et gérer leur accès de manière cohérente à travers votre wiki.

Groupes

Vous pouvez cliquer sur un groupe particulier pour mettre à jour ses paramètres, autorisations, règles de page et gérer les utilisateurs au sein de ce groupe. L’onglet Paramètres vous permet de configurer des options telles que l’URL de redirection lors de la connexion.

Modifier les paramètres du groupe

De plus, vous pouvez naviguer à travers les onglets Autorisations, Règles de page, et Utilisateurs pour contrôler ce que le groupe peut accéder et quels utilisateurs lui sont assignés.

Gestion des utilisateurs dans Wiki.js

Pour créer un nouvel utilisateur, allez dans la section Utilisateurs, cliquez sur le bouton NOUVEL UTILISATEUR, et spécifiez les détails requis.

Après cela, cliquez sur le bouton CRÉER ou CRÉER ET FERMER pour créer un nouvel utilisateur :

Créer un utilisateur

Cliquez sur un utilisateur spécifique pour afficher et éditer son profil, l’affecter à des groupes d’utilisateurs, définir des méthodes d’authentification comme les mots de passe et l’authentification à deux facteurs, et gérer son statut à l’aide d’actions telles que Désactiver, Vérifier, ou Supprimer :

Utilisateur créé

Vous pouvez également mettre à jour leurs informations de base, les métadonnées étendues (comme la localisation et le titre du poste), et suivre leur historique d’activité :

Modifier les utilisateurs

Gérer vos modules wiki

Les modules sont des fonctionnalités optionnelles qui améliorent la fonctionnalité de Wiki.js. Par exemple, le module Analytique vous permet d’activer et de configurer des intégrations comme Google Analytics pour suivre le comportement des utilisateurs et le trafic sur votre wiki.

Ajouter l'analytique

Utilisez l’onglet Authentification pour configurer et gérer les fournisseurs d’authentification (comme la connexion locale, LDAP, OAuth) et configurer les options de connexion.

Configurer les paramètres d'authentification

Vous pouvez activer ou désactiver le système de commentaires et choisir comment les utilisateurs interagissent avec les discussions de pages.

Ajouter des discussions au wiki

Configuration système

Vous pouvez également gérer comment le contenu est rendu, recherché et stocké en configurant les moteurs de rendu, l’indexation de recherche et les options de stockage. Par exemple, vous pouvez accéder à l’onglet Rendu pour personnaliser comment le contenu est rendu, tel que les paramètres du moteur Markdown ou le support des diagrammes, expressions mathématiques, etc.

Configurer le rendu des pages

Dans la section Moteur de recherche, vous pouvez configurer les options d’indexation de recherche interne et les intégrations avec des moteurs de recherche :

Configurer le moteur de recherche

Allez dans la section Stockage pour définir les cibles de sauvegarde et de synchronisation pour votre contenu. Ici, vous pouvez gérer où et comment les médias et les pièces jointes de pages sont stockés (système de fichiers local, AWS S3, etc.) :

Configurer les paramètres de stockage

Gérer la sécurité et la connectivité

Vous pouvez gérer la sécurité et la connectivité en configurant l’accès à l’API, en paramétrant l’email pour les notifications, en ajustant les politiques de sécurité et en activant SSL pour sécuriser votre site Wiki.js. Par exemple, vous pouvez gérer les tokens API pour intégrer Wiki.js avec des systèmes externes ou vos propres applications personnalisées :

Gérer les clés API

Nous pouvons configurer les paramètres email sortants pour gérer les notifications, les invitations et la récupération de mots de passe dans Wiki.js.

Configurer les paramètres de mail

Vous pouvez configurer les paramètres de Sécurité comme les délais d’expiration de session, les politiques de mot de passe et les restrictions d’accès.

Configurer les paramètres de sécurité

En plus de cela, vous pouvez mettre en place des certificats SSL/TLS pour sécuriser votre site Wiki.js avec HTTPS.

Gérer le certificat SSL TLS

En outre, vous pouvez confirmer les informations de votre wiki, telles que voir les diagnostics système, les détails du serveur et les statistiques de l’environnement d’exécution, dans la section Informations système.

Vérifier les informations système

Vous pouvez effectuer des actions de maintenance comme réindexer la recherche, vider des caches ou réinitialiser des configurations depuis l’onglet Utilitaires.

Gérer les utilitaires

Enfin, les Outils de développement vous permettent d’accéder à des outils avancés comme le terrain de jeu GraphQL, les journaux de débogage ou des scripts personnalisés :

Gérer les outils de dev

Maintenant que vous avez appris comment configurer Wiki.js avec Docker, vous pouvez l’utiliser pour créer une documentation interne, des wikis d’équipe, ou même des bases de connaissances publiques avec facilité. Si vous hésitez encore, consultez notre comparaison DokuWiki vs Wiki.js pour voir quelle plateforme convient le mieux à votre projet.