Comment installer Wiki.js sur Debian 12

Wiki.js est un logiciel wiki gratuit et open-source basé sur Node.js, Git et Markdown. Il est publié sous la licence AGPL-v3 et conçu pour la performance et la conservation des ressources système. Wiki.js est un puissant logiciel Wiki qui peut être installé n’importe où sur votre système. Vous pouvez l’installer sur votre système d’exploitation ou utiliser des services cloud tels que Heroku, et également déployer Wiki.js sur vos environnements de conteneurs, tels que Docker et Kubernetes.

Wiki.js est compatible avec la base de données PostgreSQL et fournit plus de 50 intégrations pour une authentification supplémentaire, un système de journalisation, un moteur de recherche, un rendu et un stockage. C’est un logiciel Wiki puissant construit sur des interfaces belles et intuitives pour le tableau de bord d’administration et les pages. C’est un logiciel wiki entièrement personnalisable pour documenter votre pile technologique.

Dans cet article, nous allons vous montrer comment installer Wiki.js sur un système Debian 12. Nous vous guiderons à travers l’installation de Wiki.js, en utilisant un serveur de base de données PostgreSQL, Nginx comme proxy inverse, puis sécuriser votre instance Wiki.js avec des certificats SSL/TLS de Let’s Encrypt.

Prérequis

Avant de commencer, assurez-vous d’avoir :

Un serveur Debian 12.
Un utilisateur non-root avec des privilèges d’administrateur.
Un nom de domaine pointant vers l’adresse IP de votre serveur. Cet exemple utilisera le domaine wiki.howtoforge.local.

Installation des dépendances

Dans la première étape, vous allez installer certaines des dépendances qui seront utilisées par Wiki.js, qui incluent :

Serveur de base de données PostgreSQL : Cela sera utilisé comme base de données pour votre Wiki.js.
Serveur web Nginx : Le serveur web Nginx sera utilisé comme proxy inverse pour Wiki.js.
Node.js et NPM : Le moteur d’exécution JavaScript Node.js et le gestionnaire de paquets NPM.
Certbot et le plugin Certbot Nginx : Certbot pour générer des certificats SSL/TLS via Let’s Encrypt et le plugin Certbot Nginx confirmera automatiquement votre bloc de serveur Nginx avec HTTPS.

Pour commencer, mettez à jour et rafraîchissez le dépôt Debian en utilisant la commande ci-dessous avant d’installer les paquets.

sudo apt update

Maintenant, installez les dépendances de paquets pour Wiki.js via la commande apt install ci-dessous. Avec la commande suivante, vous installerez le serveur de base de données PostgreSQL, Node.js et NPM, le serveur web Nginx, Certbot et le plugin Certbot Nginx.

sudo apt install postgresql postgresql-common nodejs npm nginx certbot python3-certbot-nginx

Tapez y pour confirmer et procéder à l’installation.

Une fois les dépendances installées, vérifiez chacune d’elles en utilisant les commandes suivantes.

Vérifiez l’état du service PostgreSQL en utilisant la commande systemctl ci-dessous.

sudo systemctl is-enabled postgresql  
sudo systemctl status postgresql

Une sortie similaire ci-dessous sera affichée.

vérification du serveur postgresql

Vérifiez l’état du service Nginx pour vous assurer qu’il fonctionne et est activé.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Si Nginx fonctionne et est activé, la sortie ci-dessous sera affichée sur votre terminal.

vérification de nginx

Enfin, vérifiez Node.js et NPM en exécutant la commande suivante. La sortie affichera les versions actuelles de Node.js et NPM installées sur votre système.

node --version  
npm --version

Création d’une base de données et d’un utilisateur PostgreSQL

Après avoir installé les dépendances, l’étape suivante consiste à créer une nouvelle base de données et un utilisateur pour votre installation de Wiki.js. Pour ce faire, vous devez vous connecter à PostgreSQL via le client psql.

Connectez-vous au serveur PostgreSQL en exécutant la commande suivante.

sudo -u postgres psql

Une fois connecté, exécutez les requêtes suivantes pour créer une nouvelle base de données PostgreSQL et un utilisateur wikijs. Assurez-vous de changer le mot de passe dans les requêtes suivantes.

CREATE USER wikijs WITH PASSWORD 'p4ssw0rd';  
CREATE DATABASE wikijs OWNER wikijs;

créer un utilisateur et une base de données

Après la création de la base de données et de l’utilisateur, vérifiez leur existence en utilisant les requêtes suivantes pour lister les bases de données et les utilisateurs disponibles sur votre instance PostgreSQL.


du  
l

Vous devriez voir la base de données et l’utilisateur wikijs créés sur PostgreSQL.

vérification de la liste des bases de données et des utilisateurs

Tapez quit pour quitter le serveur PostgreSQL.

Téléchargement du code source de Wiki.js

Dans la section suivante, vous téléchargerez le code source de Wiki.js sur votre serveur et configurerez le répertoire d’installation avec les permissions et la propriété appropriées.

Créez un nouvel utilisateur wikijs en exécutant la commande suivante.

sudo useradd -m -s /bin/false wikijs

Maintenant, créez un nouveau répertoire /opt/wikijs et déplacez-vous dedans. Ensuite, téléchargez le code source de Wiki.js via la commande wget ci-dessous.

mkdir -p /opt/wikijs; cd /opt/wikijs  
wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz

Une fois téléchargé, extrayez le code source de Wiki.js et changez la propriété du répertoire /opt/wikijs à l’utilisateur wikijs.

tar -xf wiki-js.tar.gz  
sudo chown -R wikijs:wikijs /opt/wikijs

Configuration de Wiki.js

Avec Wiki.js téléchargé, vous allez maintenant configurer votre installation de Wiki.js avec la base de données et l’utilisateur PostgreSQL, et vous allez également configurer l’adresse IP de liaison pour Wiki.js.

Copiez la configuration par défaut de Wiki.js config.sample.yml vers config.yml, puis ouvrez-la en utilisant l’éditeur nano suivant.

sudo -u wikijs cp config.sample.yml config.yml  
sudo -u wikijs nano config.yml

Changez la configuration de base de données par défaut avec votre base de données PostgreSQL, utilisateur et mot de passe.

  # PostgreSQL / MySQL / MariaDB / MS SQL Server uniquement :  
  host: localhost  
  port: 5432  
  user: wikijs  
  pass: p4ssw0rd  
  db: wikijs  
  ssl: false

Changez l’option bindIP par défaut en localhost ou 127.0.0.1. Cela fera fonctionner Wiki.js sur le localhost.

bindIP: 127.0.0.1

Enregistrez et quittez après avoir terminé.

Ensuite, exécutez la commande suivante pour exécuter et tester votre installation de Wiki.js.

sudo -u wikijs node server

Vous devriez voir la confirmation que Wiki.js fonctionne sur localhost avec le port par défaut 3000.

configuration de wiki.js

Enfin, appuyez sur Ctrl+c pour terminer le processus de Wiki.js.

Exécution de Wiki.js en arrière-plan en tant que service

Maintenant que vous avez terminé la configuration de Wiki.js, l’étape suivante consiste à configurer Wiki.js pour s’exécuter en arrière-plan en tant que service systemd. En utilisant l’approche suivante, vous pouvez facilement gérer Wiki.js via l’utilitaire systemctl.

Créez un nouveau fichier de service systemd pour Wiki.js /etc/systemd/system/wikijs.service en utilisant la commande de l’éditeur nano ci-dessous.

sudo nano /etc/systemd/system/wikijs.service

Insérez la configuration suivante qui permettra à Wiki.js de s’exécuter en arrière-plan en tant que service.

[Unit]  
Description=Wiki.js  
After=network.target postgresql.service  
  
[Service]  
Type=simple  
ExecStart=/usr/bin/node server  
Restart=always  
  
User=wikijs  
Environment=NODE_ENV=production  
WorkingDirectory=/opt/wikijs  
  
[Install]  
WantedBy=multi-user.target

Enregistrez le fichier et quittez l’éditeur une fois terminé.

Ensuite, exécutez la commande systemctl ci-dessous pour recharger le gestionnaire systemd et appliquer le nouveau fichier de service pour Wiki.js.

sudo systemctl daemon-reload

Vous pouvez maintenant démarrer et activer le service wiki.js en utilisant la commande ci-dessous. Cela démarrera Wiki.js en arrière-plan sur localhost avec le port par défaut 3000 et l’activera pour s’exécuter automatiquement au démarrage.

sudo systemctl start wikijs  
sudo systemctl enable wikijs

démarrer activer wiki.js

Vérifiez le service wikijs en utilisant la commande ci-dessous pour vous assurer que le service fonctionne.

sudo systemctl status wikijs

Une sortie ci-dessous devrait être présentée.

vérification du service wiki.js

Enfin, exécutez la commande ss ci-dessous pour vérifier le port 3000 qui est utilisé par l’application Wiki.js.

ss -tulpn | grep 3000

Si Wiki.js fonctionne, vous devriez voir que l’application Node.js utilise le port 3000.

Configuration de Nginx en tant que proxy inverse

Maintenant que Wiki.js fonctionne sur localhost avec le port par défaut 3000. Dans l’étape suivante, vous allez créer une nouvelle configuration de bloc de serveur Nginx qui sera utilisée comme proxy inverse pour Wiki.js. Avant de commencer, assurez-vous d’avoir un nom de domaine pointant vers l’adresse IP de votre serveur.

Créez une nouvelle configuration de bloc de serveur Nginx /etc/nginx/sites-available/wikijs en utilisant la commande de l’éditeur nano suivante.

sudo nano /etc/nginx/sites-available/wikijs

Insérez la configuration suivante et assurez-vous de changer le nom de domaine de votre installation de Wiki.js.

server {  
    listen 80;  
    server_name wiki.howtoforge.local;  
  
    root /opt/wikijs;  
  
    access_log  /var/log/nginx/wikijs.access.log;  
    error_log   /var/log/nginx/wikijs.error.log;  
  
    location / {  
        proxy_http_version 1.1;  
        proxy_set_header Upgrade $http_upgrade;  
        proxy_set_header Connection "upgrade";  
        proxy_set_header Host $http_host;  
        proxy_set_header X-Real-IP $remote_addr;  
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
        proxy_set_header X-Forwarded-Proto $scheme;  
        proxy_pass http://127.0.0.1:3000;  
    }  
}

Enregistrez le fichier et quittez l’éditeur une fois terminé.

Ensuite, exécutez la commande suivante pour activer la configuration du bloc de serveur Wiki.js et vérifier la syntaxe de Nginx.

sudo ln -s /etc/nginx/sites-available/wikijs /etc/nginx/sites-enabled  
sudo nginx -t

Si vous avez une syntaxe Nginx correcte, vous devriez obtenir une sortie test réussi - syntaxe correcte.

Maintenant, redémarrez le service Nginx en utilisant la commande ci-dessous pour appliquer le nouveau bloc de serveur que vous avez configuré.

sudo systemctl restart nginx

Une fois que Nginx est redémarré, lancez votre navigateur web préféré et visitez le nom de domaine de votre installation de Wiki.js, tel que http://wiki.howtoforge.local/. Si tout se passe bien, vous devriez voir la page d’installation de Wiki.js comme ceci :

page d'installation wiki.js

Sécurisation de Wiki.js avec des certificats SSL/TLS

Dans l’étape suivante, vous allez sécuriser votre installation de Wiki.js avec des certificats SSL/TLS de Letsencrypt. De plus, vous allez configurer le passage automatique de HTTP à HTTPS via le plugin Certbot Nginx.

Exécutez la commande certbot ci-dessous pour générer de nouveaux certificats SSL/TLS de letsencrypt. Assurez-vous de changer les détails du nom de domaine et de l’adresse e-mail avec vos informations.

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d wiki.howtoforge.local

Après la fin du processus, vos certificats SSL seront disponibles dans le répertoire /etc/letsencrypt/live/wiki.howtoforge.local/. En ce qui concerne la configuration du bloc de serveur Wiki.js, elle sera automatiquement configurée avec HTTPS via le plugin Certbot Nginx.

Démarrage de l’installation de Wiki.js

Retournez à votre navigateur web et visitez votre nom de domaine Wiki.js, par exemple, http://wiki.howtoforge.local/. Vous devriez être automatiquement redirigé vers une connexion HTTPS sécurisée.

Maintenant, créez l’utilisateur administrateur pour Wiki.js et saisissez votre adresse e-mail et votre mot de passe. Ensuite, cliquez sur INSTALLER pour confirmer l’installation.

installation de wiki.js

Une fois l’installation terminée, vous devriez être redirigé vers votre page de connexion Wiki.js. Saisissez votre adresse e-mail admin et votre mot de passe, puis cliquez sur CONNEXION.

page de connexion Wiki.js

Si votre installation est réussie, vous devriez voir la page d’accueil de Wiki.js. À partir de là, vous pouvez créer une nouvelle page d’accueil ou accéder au tableau de bord d’administration de Wiki.js.

succès de l'installation

Si vous cliquez sur ADMINISTRATION, vous devriez voir la page d’administration de Wiki.js comme ceci :

tableau de bord d'administration wiki.js

Dans la section SYSTÈME, cliquez sur le menu Informations système pour obtenir des informations détaillées sur votre installation de Wiki.js. Vous devriez voir que Wiki.js 2.5 est installé avec Node.js 18.x et PostgreSQL 15.x.

informations système wiki.js

Conclusion

C’est tout ! Vous avez suivi toutes les étapes et installé Wiki.js sur votre système Debian 12, complet avec un serveur de base de données PostgreSQL, Nginx en tant que proxy inverse, et sécurisé l’installation via des certificats SSL/TLS de Let’s Encrypt. Vous pouvez maintenant commencer à construire la documentation de votre entreprise avec Wiki.js.