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

Wiki.js est une puissante plate-forme wiki open source construite sur Node.js. Il prend en charge Markdown et l’édition WYSIWYG, la collaboration en temps réel, le contrôle des versions et les options d’authentification flexibles, y compris Google et LDAP. Dans ce guide, nous vous montrerons comment configurer wiki.js avec Docker afin que vous puissiez faire fonctionner votre wiki en quelques minutes.

Installer wiki.js à l’aide de docker compose

En utilisant Docker et Docker Compose, il est incroyablement facile de configurer Wiki.js. Tout d’abord, créez un répertoire nommé «Wikijs-Docker» et accédez à lui à l’aide de 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 puis, 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 à l’aide de la commande suivante:

docker compose up -d

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

Après l’installation, entrez vos informations d’identification pour vous connecter.

Création et gestion des pages dans wiki.js

Maintenant vous pouvez créer le 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:

Si vous cliquez sur le Créer une page d’accueil bouton, il vous sera demandé de sélectionner un éditeur pour la page. Sélectionnez celui en fonction de vos préférences et exigences:

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

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

Gérer et organiser le contenu

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

Paramètres du site wiki.js

Dans le panneau d’administration wiki.js, vous pouvez configurer des paramètres de site tels que les paramètres régionaux, la navigation, les thèmes et les balises. Ces options aident à définir la configuration globale de votre instance wiki.js.

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

Accédez à la Lieu Tab pour définir la langue par défaut, le fuseau horaire et les formats de date / heure utilisés sur le site:

Pour gérer la structure des menus de votre wiki et contrôler la façon dont les utilisateurs parcourent le contenu, allez au Barre de navigation.

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

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

Gérer les groupes sur votre wiki

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

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

De plus, vous pouvez naviguer à travers le Autorisation, Règles de la pageet Utilisateurs Onglets pour contrôler ce à quoi le groupe peut accéder et les utilisateurs qui lui sont affectés.

Gestion des utilisateurs dans wiki.js

Pour créer un nouvel utilisateur, allez au Utilisateurs Section, cliquez sur le Nouvel utilisateur bouton, et spécifiez les détails requis.

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

Cliquez sur un utilisateur spécifique Pour afficher et modifier leur profil, affectez-les à des groupes d’utilisateurs, définissez des méthodes d’authentification comme les mots de passe et l’authentification à deux facteurs, et gérer leur statut à l’aide d’actions telles que Désactiver, Vérifierou Supprimer:

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

Gérez vos modules wiki

Les modules sont des fonctionnalités facultatives qui améliorent la fonctionnalité wiki.js. Par exemple, le Analytique Le module 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.

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

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

Configuration du système

Vous pouvez également gérer la façon dont le contenu est rendu, recherché et stocké en configurant les moteurs de rendu, l’indexation de la recherche et les options de stockage. Par exemple, vous pouvez naviguer vers le Rendu Onglet Pour personnaliser la façon dont le contenu est rendu, tel que les paramètres de moteur Markdown ou la prise en charge des diagrammes, des expressions mathématiques, etc.

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

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

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 configurant les e-mails pour les notifications, en ajustant les politiques de sécurité et en permettant à SSL de sécuriser votre site wiki.js. Par exemple, vous pouvez gérer Jetons API Pour intégrer wiki.js avec des systèmes externes ou vos propres applications personnalisées:

Nous pouvons configurer sortant e-mail Paramètres pour gérer les notifications, les invitations et la récupération de mot de passe dans wiki.js.

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

En dehors de cela, vous pouvez installer SSL / TLS Certificats pour sécuriser votre site wiki.js avec HTTPS.

En dehors de cela, vous pouvez confirmer vos informations de wiki, telles que les diagnostics du système Afficher, les détails du serveur et les statistiques de l’environnement d’exécution, à partir de la Informations système section.

Vous pouvez effectuer des actions de maintenance telles que la réindexation de la recherche, la nettoyage des caches ou la réinitialisation des configurations à partir de la Services publics languette.

Enfin, le Outils de développeur Permettez-vous d’accéder aux outils avancés comme GraphQL Playground, les journaux de débogage ou les scripts personnalisés:

Maintenant que vous avez appris à 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 pesez toujours vos options, consultez notre comparaison Dokuwiki vs wiki.js pour voir quelle plate-forme est la bonne adaptation pour votre projet.