Guide rapide pour configurer votre propre wiki avec Wiki.js en quelques minutes

Wiki.js est une application wiki open source riche en fonctionnalités, conçue sur le framework Node.js. Elle offre une expérience d’édition polyvalente avec la prise en charge des interfaces Markdown et WYSIWYG. De plus, elle facilite la collaboration en temps réel, le contrôle de version et diverses méthodes d’authentification, notamment les intégrations Google et LDAP. Ce guide complet vous guidera pas à pas pour configurer Wiki.js avec Docker et déployer votre propre wiki en quelques minutes seulement.

Configuration de Wiki.js via Docker Compose

La configuration de Wiki.js avec Docker et Docker Compose est simple. Commencez par créer un nouveau répertoire wikijs-dockeret accédez-y :

mkdir wikijs-docker && cd wikijs-docker

Ensuite, créez un fichier nommé docker-compose.ymlà l’aide de votre éditeur de texte préféré :

nano docker-compose.yml

Ensuite, insérez la configuration suivante dans le 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:

Après avoir enregistré et fermé le fichier, lancez les conteneurs en exécutant la commande suivante :

docker compose up -d

Une fois l’installation terminée, accédez à http://localhost dans votre navigateur web. Vous devrez alors saisir les informations de votre compte administrateur et cliquer sur le bouton « Installer » pour lancer l’installation :

Une fois l’installation terminée, connectez-vous à l’aide de vos identifiants.

Création et gestion de pages dans Wiki.js

Une fois la configuration initiale terminée, vous pouvez établir votre page d’accueil pour commencer à remplir votre contenu ou accéder au panneau d’administration pour gérer vos paramètres, vos utilisateurs et les fonctionnalités disponibles :

En cliquant sur l’ option Créer une page d’accueil, vous serez invité à choisir un éditeur adapté à vos préférences :

Ensuite, définissez les propriétés de votre page et appuyez sur le bouton OK pour procéder à la création d’une nouvelle page :

Rédigez le contenu souhaité et cliquez sur le bouton Créer pour finaliser la création de la page :

Gestion et organisation du contenu

Votre tableau de bord vous permet de consulter et de modifier facilement les pages existantes, ainsi que d’en créer de nouvelles avec l’éditeur de votre choix. Vous pouvez organiser votre contenu en renommant, déplaçant ou supprimant des pages, et utiliser des balises pour une catégorisation efficace. De plus, la barre latérale et la fonction de recherche accélèrent la navigation vers des pages spécifiques de votre wiki :

Configuration des paramètres du site Wiki.js

Depuis le panneau d’administration de Wiki.js, vous pouvez configurer les paramètres du site, tels que les paramètres régionaux, les structures de navigation, les thèmes et les balises. Ces paramètres jouent un rôle crucial dans la configuration globale de votre instance Wiki.js.

Sous l’ onglet Général, vous pouvez ajuster les paramètres fondamentaux du site, notamment le titre du site, la description, la page d’accueil par défaut et les paramètres de visibilité (publics ou privés) :

Passez à l’ onglet Paramètres régionaux pour spécifier la langue par défaut, le fuseau horaire et les formats de date/heure pour votre site :

Pour gérer la structure du menu de votre wiki et améliorer la navigation des utilisateurs, visitez la section Barre de navigation :

Dans l’ onglet Pages, vous pouvez superviser, modifier et organiser toutes les pages wiki, créer de nouvelles pages et gérer la hiérarchie de votre contenu :

De plus, sous l’ onglet Balises, vous pouvez créer et gérer des balises de contenu, améliorant ainsi la recherche sur les pages. Vous pouvez également personnaliser l’esthétique de votre wiki via l’ onglet Thème, où vous pouvez modifier le logo, les couleurs, les polices et la mise en page du site.

Gérer les groupes dans votre wiki

La section « Groupes » vous permet de créer des groupes d’utilisateurs, de désigner des membres et d’établir des autorisations d’accès au niveau des groupes. Cette méthode d’organisation simplifie les rôles des utilisateurs et assure une gestion cohérente des accès sur l’ensemble de votre wiki.

Cliquer sur un groupe spécifique permet de mettre à jour ses paramètres, ses autorisations, ses règles de page et la gestion des utilisateurs au sein de ce groupe. L’ onglet « Paramètres » vous permet de modifier les options, notamment l’URL de redirection de connexion.

Vous pouvez également parcourir les sections Autorisations, Règles de page et Utilisateurs pour affiner ce à quoi le groupe peut accéder et attribuer des utilisateurs en conséquence.

Gestion des utilisateurs dans Wiki.js

Pour ajouter un nouvel utilisateur, accédez à la section Utilisateurs, cliquez sur le bouton NOUVEL UTILISATEUR et remplissez les champs obligatoires.

Une fois terminé, sélectionnez CRÉER ou CRÉER ET FERMER pour finaliser la configuration du nouvel utilisateur :

La sélection d’un utilisateur particulier vous permet d’afficher et de modifier son profil, d’attribuer des groupes d’utilisateurs, de définir des méthodes d’authentification (comme des mots de passe ou une authentification à deux facteurs) et de gérer son statut avec des actions telles que Désactiver, Vérifier ou Supprimer :

De plus, vous pouvez mettre à jour leurs informations de base, leurs métadonnées étendues (y compris l’emplacement et le titre du poste) et consulter leur historique d’activité :

Gérer vos modules Wiki

Les modules sont des améliorations qui augmentent les capacités de Wiki.js. Par exemple, le module Analytics vous permet d’intégrer des outils comme Google Analytics pour suivre l’engagement des utilisateurs et les indicateurs de trafic :

Utilisez l’ onglet Authentification pour établir et gérer les fournisseurs d’authentification (connexion locale, LDAP, OAuth) tout en configurant diverses options de connexion :

Configurer les paramètres d'authentification

Vous pouvez également activer ou désactiver le système de commentaires et déterminer comment les utilisateurs participent aux discussions sur la page :

Configuration du système

Gérez le rendu, l’indexation et le stockage du contenu en configurant les moteurs de rendu, l’indexation de recherche et les paramètres de stockage. Par exemple, accédez à l’ onglet Rendu pour personnaliser le rendu du contenu, par exemple en ajustant les paramètres du moteur Markdown ou en activant la prise en charge des diagrammes et des expressions mathématiques :

Dans la section Moteur de recherche, vous pouvez gérer les options d’indexation de recherche interne et les intégrations de moteurs de recherche tiers :

Dans la section Stockage, spécifiez les cibles de sauvegarde et de synchronisation pour votre contenu, ce qui vous permet de gérer où et comment les pièces jointes multimédias et de page sont stockées (par exemple sur le système de fichiers local ou AWS S3) :

Gestion de la sécurité et de la connectivité

Vous pouvez sécuriser votre instance Wiki.js en configurant l’accès à l’API, en paramétrant les notifications par e-mail, en ajustant les politiques de sécurité et en activant SSL pour une expérience sécurisée. Par exemple, gérez les jetons d’API pour intégrer Wiki.js à d’autres applications :

Configurez les configurations de messagerie pour gérer les notifications, les invitations et les processus de récupération de mot de passe dans Wiki.js :

Les paramètres de sécurité peuvent également être affinés, couvrant des aspects tels que les délais d’expiration des sessions, les politiques de mot de passe et les restrictions d’accès :

De plus, vous pouvez configurer des certificats SSL/TLS pour garantir que votre instance Wiki.js fonctionne en toute sécurité via HTTPS :

De plus, vérifiez les informations de votre Wiki telles que les diagnostics système, les spécifications du serveur et les statistiques de l’environnement d’exécution dans la section Informations système :

Effectuez des activités de maintenance telles que la réindexation des résultats de recherche, la suppression des données mises en cache ou la réinitialisation des configurations à partir de l’ onglet Utilitaires :

Enfin, les outils de développement offrent des ressources avancées telles que l’aire de jeux GraphQL, des capacités de débogage de journaux ou des intégrations de scripts personnalisés :

Maintenant que vous disposez des connaissances nécessaires pour configurer Wiki.js à l’aide de Docker, vous pouvez utiliser cette plateforme en toute confiance pour créer sans effort une documentation interne, des wikis d’équipe collaboratifs ou des bases de connaissances publiques.

Source et images