Cómo instalar Wiki.js en Debian 12

Wiki.js es un software de wiki gratuito y de código abierto basado en Node.js, Git y Markdown. Se publica bajo la Licencia AGPL-v3 y está diseñado para el rendimiento y la conservación de los recursos del sistema. Wiki.js es un potente software de wiki que se puede instalar en cualquier lugar de su sistema. Puede instalarlo en su sistema operativo o utilizar servicios en la nube como Heroku, y también desplegar Wiki.js en sus entornos de contenedores, como Docker y Kubernetes.

Wiki.js es compatible con la base de datos PostgreSQL y proporciona más de 50 integraciones para autenticación adicional, sistema de registro, motor de búsqueda, renderizado y almacenamiento. Es un potente software de wiki construido sobre interfaces hermosas e intuitivas tanto para el panel de administración como para las páginas. Es un software de wiki completamente personalizable para documentar su pila tecnológica.

En este artículo, le mostraremos cómo instalar Wiki.js en un sistema Debian 12. Lo guiaremos a través de la instalación de Wiki.js, utilizando un servidor de base de datos PostgreSQL, Nginx como proxy inverso, y luego aseguraremos su instancia de Wiki.js con certificados SSL/TLS de Let’s Encrypt.

Requisitos previos

Antes de continuar, asegúrese de tener:

• Un servidor Debian 12.
• Un usuario no root con privilegios de administrador.
• Un nombre de dominio apuntando a la dirección IP de su servidor. Este ejemplo utilizará el dominio wiki.howtoforge.local.

Instalación de dependencias

En la primera etapa, instalará algunas de las dependencias que serán utilizadas por Wiki.js, que incluyen:

• Servidor de base de datos PostgreSQL: Este se utilizará como la base de datos para su Wiki.js.
• Servidor web Nginx: El servidor web Nginx se utilizará como un proxy inverso para Wiki.js.
• Node.js y NPM: El motor de ejecución de JavaScript Node.js y el gestor de paquetes NPM.
• Certbot y el complemento Certbot de Nginx: Certbot para generar certificados SSL/TLS a través de Let’s Encrypt y el complemento Certbot de Nginx confirmará automáticamente su bloque de servidor Nginx con HTTPS.

Para comenzar, actualice y refresque el repositorio de Debian utilizando el comando a continuación antes de instalar paquetes.

sudo apt update

Ahora instale las dependencias de paquetes para Wiki.js a través del comando apt install a continuación. Con el siguiente comando, instalará el servidor de base de datos PostgreSQL, Node.js y NPM, el servidor web Nginx, Certbot y el complemento Nginx de Certbot.

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

Escriba y para confirmar y proceder con la instalación.

Una vez que las dependencias estén instaladas, verifique cada una de ellas utilizando los siguientes comandos.

Verifique el estado del servicio PostgreSQL utilizando el comando systemctl a continuación.

sudo systemctl is-enabled postgresql  
sudo systemctl status postgresql

Se mostrará una salida similar a continuación.

Verifique el estado del servicio Nginx para asegurarse de que esté en ejecución y habilitado.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Si Nginx está en ejecución y habilitado, la salida a continuación se mostrará en su terminal.

Por último, verifique Node.js y NPM ejecutando el siguiente comando. La salida mostrará las versiones actuales de Node.js y NPM instaladas en su sistema.

node --version  
npm --version

Creando una base de datos y usuario de PostgreSQL

Después de instalar las dependencias, el siguiente paso es crear una nueva base de datos y un usuario para su instalación de Wiki.js. Para hacer eso, debe iniciar sesión en PostgreSQL a través del cliente psql.

Inicie sesión en el servidor PostgreSQL ejecutando el siguiente comando.

sudo -u postgres psql

Una vez que haya iniciado sesión, ejecute las siguientes consultas para crear una nueva base de datos PostgreSQL y el usuario wikijs. Asegúrese de cambiar la contraseña en las siguientes consultas.

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

Después de que la base de datos y el usuario se hayan creado, verifique su existencia utilizando las siguientes consultas para listar las bases de datos y usuarios disponibles en su instancia de PostgreSQL.

du  

l

Debería ver la base de datos y el usuario wikijs creados en PostgreSQL.

Escriba quit para salir del servidor PostgreSQL.

Descargando el código fuente de Wiki.js

En la siguiente sección, descargará el código fuente de Wiki.js en su servidor y configurará el directorio de instalación con los permisos y la propiedad adecuados.

Cree un nuevo usuario wikijs ejecutando el siguiente comando.

sudo useradd -m -s /bin/false wikijs

Ahora cree un nuevo directorio /opt/wikijs y muévase a él. Luego, descargue el código fuente de Wiki.js a través del comando wget a continuación.

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

Una vez descargado, extraiga el código fuente de Wiki.js y cambie la propiedad del directorio /opt/wikijs al usuario wikijs.

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

Configurando Wiki.js

Con Wiki.js descargado, a continuación configurará su instalación de Wiki.js con la base de datos y el usuario de PostgreSQL, y también configurará la dirección IP de enlace para Wiki.js.

Copie la configuración predeterminada de Wiki.js config.sample.yml a config.yml, luego ábralo usando el siguiente editor nano.

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

Cambie la configuración de base de datos predeterminada con su base de datos PostgreSQL, usuario y contraseña.

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

Cambie la opción bindIP predeterminada a localhost o 127.0.0.1. Esto ejecutará Wiki.js en el localhost.

bindIP: 127.0.0.1

Guarde y salga después de terminar.

A continuación, ejecute el siguiente comando para ejecutar y probar su instalación de Wiki.js.

sudo -u wikijs node server

Debería ver la confirmación de que Wiki.js está en ejecución en localhost con el puerto predeterminado 3000.

Por último, presione Ctrl+c para terminar el proceso de Wiki.js.

Ejecutando Wiki.js en segundo plano como un servicio

Ahora que ha completado la configuración de Wiki.js, el siguiente paso será configurar Wiki.js para que se ejecute en segundo plano como un servicio systemd. Al usar el siguiente enfoque, puede administrar fácilmente Wiki.js a través de la utilidad systemctl.

Cree un nuevo archivo de servicio systemd para Wiki.js /etc/systemd/system/wikijs.service utilizando el comando del editor nano a continuación.

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

Inserte la siguiente configuración que permitirá que Wiki.js se ejecute en segundo plano como un servicio.

[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

Guarde el archivo y salga del editor cuando haya terminado.

A continuación, ejecute el comando systemctl a continuación para recargar el gestor systemd y aplicar el nuevo archivo de servicio para Wiki.js.

sudo systemctl daemon-reload

Ahora puede iniciar y habilitar el servicio wiki.js utilizando el comando a continuación. Esto iniciará Wiki.js en segundo plano en localhost con el puerto predeterminado 3000 y lo habilitará para que se ejecute automáticamente al arrancar.

sudo systemctl start wikijs  
sudo systemctl enable wikijs

Verifique el servicio wikijs utilizando el comando a continuación para asegurarse de que el servicio esté en ejecución.

sudo systemctl status wikijs

Se debería presentar una salida a continuación.

Por último, ejecute el comando ss a continuación para verificar el puerto 3000 que es utilizado por la aplicación Wiki.js.

ss -tulpn | grep 3000

Si Wiki.js está en ejecución, debería ver que la aplicación Node.js utiliza el puerto 3000.

Configurando Nginx como un proxy inverso

Ahora que Wiki.js está en ejecución en localhost con el puerto predeterminado 3000. En el siguiente paso, creará una nueva configuración de bloque de servidor Nginx que se utilizará como un proxy inverso para Wiki.js. Antes de comenzar, asegúrese de tener un nombre de dominio apuntando a la dirección IP de su servidor.

Cree una nueva configuración de bloque de servidor Nginx /etc/nginx/sites-available/wikijs utilizando el siguiente comando del editor nano.

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

Inserte la siguiente configuración y asegúrese de cambiar el nombre de dominio de su instalación 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;  
    }  
}

Guarde el archivo y salga del editor cuando haya terminado.

A continuación, ejecute el siguiente comando para habilitar la configuración del bloque de servidor de Wiki.js y verificar la sintaxis de Nginx.

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

Si tiene la sintaxis de Nginx correcta, debería obtener una salida la prueba es exitosa - la sintaxis es correcta.

Ahora reinicie el servicio Nginx utilizando el comando a continuación para aplicar el nuevo bloque de servidor que ha configurado.

sudo systemctl restart nginx

Una vez que Nginx se reinicie, inicie su navegador web preferido y visite el nombre de dominio de su instalación de Wiki.js, como http://wiki.howtoforge.local/. Si todo va bien, debería ver la página de instalación de Wiki.js como esta:

Asegurando Wiki.js con certificados SSL/TLS

En el siguiente paso, asegurará su instalación de Wiki.js con certificados SSL/TLS de Letsencrypt. Además, configurará HTTP a HTTPS automático a través del complemento Certbot de Nginx.

Ejecute el comando certbot a continuación para generar nuevos certificados SSL/TLS de letsencrypt. Asegúrese de cambiar los detalles del nombre de dominio y la dirección de correo electrónico con su información.

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

Después de que el proceso haya finalizado, sus certificados SSL estarán disponibles en el directorio /etc/letsencrypt/live/wiki.howtoforge.local/. En cuanto a la configuración del bloque de servidor de Wiki.js, se configurará automáticamente con HTTPS a través del complemento Certbot de Nginx.

Iniciando la instalación de Wiki.js

Regrese a su navegador web y visite el nombre de dominio de su Wiki.js, por ejemplo, http://wiki.howtoforge.local/. Debería ser redirigido automáticamente a una conexión HTTPS segura.

Ahora cree el usuario administrador para Wiki.js e ingrese su dirección de correo electrónico y contraseña. Luego, haga clic en INSTALAR para confirmar la instalación.

Una vez que la instalación haya finalizado, debería ser redirigido a la página de inicio de sesión de su Wiki.js. Ingrese su dirección de correo electrónico y contraseña de administrador, luego haga clic en INICIAR SESIÓN.

Si su instalación es exitosa, debería ver la página de bienvenida de Wiki.js. Desde aquí, puede crear una nueva página de inicio o acceder al panel de administración de Wiki.js.

Si hace clic en ADMINISTRACIÓN, debería ver la página de administración de Wiki.js como esta:

En la sección SISTEMA, haga clic en el menú Información del sistema para obtener información detallada sobre su instalación de Wiki.js. A continuación, debería ver que Wiki.js 2.5 está instalado con Node.js 18.x y PostgreSQL 15.x.

Conclusión

¡Eso es todo! Ha seguido todos los pasos e instalado Wiki.js en su sistema Debian 12, completo con un servidor de base de datos PostgreSQL, Nginx como proxy inverso, y asegurado la instalación a través de certificados SSL/TLS de Let’s Encrypt. Ahora puede comenzar a construir la documentación de su empresa con Wiki.js.