Wiki.js, una wiki de código abierto basada en Node.js, Git y Markdown
En el siguiente artículo vamos a echar un vistazo a Wiki.js. Esta es una aplicación wiki de código abierto ligera y gratuita construida con Node.js. A diferencia de otras plataformas wiki, esta guarda todo tu contenido directamente en archivos Markdown (.md). Este contenido es automáticamente sincronizado con el repositorio remoto de Git del usuario.
Se trata de una aplicación wiki de código abierto, moderna y potente basada en Node.js, Git y Markdown. El código fuente de Wiki.js está disponible públicamente en Github, listo para descargar e instalar. Esto es posible porque Wiki.js es completamente de código abierto, bajo la licencia GNU AGPLv3.
Características generales de Wiki.js
- Vamos a poder escribir nuestro contenido en formato Markdown. Utilizaremos el editor visual incorporado.
- A diferencia de otro software wiki que guarda contenido en una base de datos, Wiki.js guarda todo el contenido directamente en archivos Markdown (.md). Este contenido se sincroniza automáticamente con nuestro repositorio remoto de Git. Si es que nos interesa.
- La aplicación se ejecuta en el motor Node.js. Está optimizado para utilizar pocos recursos de CPU. Se basa, en gran medida, en el almacenamiento en caché para entregar el contenido rápidamente a los usuarios.
- El contenido que se genere se procesa automágicamente en un formato de lectura limpio. Se presenta dentro de una elegante interfaz de usuario.
- Vamos a poder restringir el acceso a nuestra Wiki a ciertos usuarios o incluso solo a partes del contenido.
- Podremos iniciar sesión usando la base de datos local. También vamos a poder conectarnos usando proveedores externos de autenticación como Microsoft Account, Google ID, etc.
- El programa nos dará la posibilidad de insertar imágenes, esquemas, documentos, vídeos, enlaces, etc. Para esto se utilizará el administrador de activos que incorpora.
- Vamos a poder encontrar rápidamente la entrada wiki que estemos buscando utilizando el motor de búsqueda incorporado. Nos va a proporcionar resultados y sugerencias relevantes al analizar los metadatos y el contenido de nuestras entradas wiki.
Requisitos del servidor
Para poder hacer funcionar este programa, necesitaremos disponer de algunas cosas en nuestro servidor.
- Node.js 6.9.0 o superior.
- MongoDB 3.2 o superior.
- Git 2.7.4 o superior.
- Un repositorio de Git (público o privado). Esto es opcional.
Instalar Wiki.js en Ubuntu
Este breve post vamos a ver cómo instalar Wiki.js en un servidor Ubuntu 18.04 con todos sus requisitos necesarios.
Instalar Git
Para empezar necesitaremos instalar Git para ejecutar Wiki.js. Git viene preinstalado en el servidor Ubuntu. Es posible que no necesites instalarlo. Sin embargo, si necesitas la última versión de Git, agrega el siguiente repositorio e instálalo:
sudo add-apt-repository -y ppa:git-core/ppa sudo apt update && sudo apt upgrade sudo apt install git
Instalar Node.js
Node.js es otro requisito obligatorio para hacer funcionar Wiki.js. Solo tendremos que ejecutar los siguientes comandos para instalar Node.js:
sudo apt install curl curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - sudo apt install -y nodejs
Instalar MongoDB
MongoDB es también uno de los requisitos obligatorios para Wiki.js. Vamos a instalar la versión que viene en el repositorio de Ubuntu. Tan solo tendremos que ejecutar el comando:
sudo apt install mongodb
Descargar e instalar Wiki.js
Una vez cumplidos todos los requisitos, ya podemos descargar el script de instalación de Wiki.js y lanzarlo. Para hacerlo ejecuta:
sudo mkdir /var/www/wikijs cd /var/www/wikijs curl -sSo- https://wiki.js.org/install.sh | sudo bash
Tras ejecutar el última comando, deberías ver un mensaje de éxito como el siguiente:
Después de la instalación, se nos pedirá que ejecutemos el asistente de configuración. Podemos iniciarlo ejecutando:
sudo node wiki configure
Este comando nos mostrará un mensaje para abrir en el navegador la URL http://localhost:3000 para configurar Wiki.js.
Si abrimos nuestro navegador y buscamos el nombre de host del servidor o la dirección IP seguidos por el puerto se iniciará el asistente. Aquí tendremos diferentes pantallas de configuración. Si no queremos complicarnos mucho, podemos aceptar la configuración predeterminada y continuar.
El programa validará que el sistema cumple con los requisitos necesarios.
Lo siguiente que tendremos que cumplimentar será la configuración general.
Después tendremos que configurar la conexión de MongoDB. Si la instalación que realizamos antes ha sido correcta, podemos pulsar el botón “Connect“. La siguiente ventana será la de la configuración de los Paths. Aquí recomiendan dejarla pode defecto así que continuamos con la instalación.
En la siguiente pantalla podremos añadir los datos de nuestra cuenta Git, o omitir este paso.
Ahora tendremos que crear una cuenta de administrador para loguearnos más tarde.
Después de esto y algunas otras pantallas de configuración, Wiki.js debería estar instalado y listo para utilizar.
Al finalizar tendremos que loguearnos. Usaremos la cuenta de administrador que hemos creado antes para crear nuestra página principal.
Y tras todo esto, llegaremos al editor. Aquí es desde donde podremos empezar a crear.
Esta es solo una instalación básica. Para obtener más información sobre esta plataforma wiki, sobre su instalación, su uso o para ver la documentación oficial, podemos visitar la página del proyecto.
El artículo Wiki.js, una wiki de código abierto basada en Node.js, Git y Markdown ha sido originalmente publicado en Ubunlog.