Matterwiki, montando una Wiki para nuestra empresa

Partiendo del buen objetivo de cada uno (y cada empresa), sabemos que tenemos que tener documentado todo lo que podamos, evitando tenerlo en la cabeza o cuando se nos va un técnico no se nos vaya con información vital, sí o sí todos tenemos que documentar. Así que lo dicho, os dejo Matterwiki, que no es más que una Wiki súper simple, podemos usarla de repositorio y almacenar ahí todos nuestros How To’s, trucos, apuntes…

Y por supuesto cada uno puede usar lo que quiera, esta Wiki llevo bastante tiempo usandola y sin pegas, se basa en un contenedor de docker, así que más fácil imposible, la descargamos, la arrancamos y la tenemos lista. Personalmente veréis que me gusta sacar los datos fuera, esto es, se almacena usando un MySQL local, más abajo os pondré los pasos para usar uno externo si os interesase, y ya para rematar, pues un ejemplo personalizándolo y cambiándole el tema para hacerlo más corporativo y se integre mejor en nuestra empresa.

 

Nos basamos en una Debian 9.9, os dejo los pasos si necesitaseis para instalar Docker, donde primero instalaremos las dependencias, posteriormente importaremos la clave GPG del repositorio de Docker y finalmente instalamos Docker:

sudo apt install apt-transport-https ca-certificates curl software-properties-common gnupg2 git -y
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable"
sudo apt update
sudo apt install docker-c

 

Y una vez tengamos Docker corriendo, Matterwiki lo instalamos en un minuto, primero nos clonamos su repositorio y creamos la imagen del contenedor

git clone https://github.com/hydrog3n/dockerfiles.git
cd dockerfiles/matterwiki
docker build -t matterwiki .

 

Modificamos el secreto en el fichero de JWT:

/var/lib/docker/overlay2/[ID]/diff/matterwiki/config.js

 

Y podriamos arrancar ya el contenedor con:

docker run --name=matterwiki -p 5000:5000 matterwiki

 

En mi caso como comentaba, utilizo un servidor MySQL externo, así que os paso los parámetros que deberíamos indicar a la hora de arrancar el contenedor:

docker run --name matterwiki -p 5000:5000 -e MYSQL_HOST=DIRECCION_IP_SERVIDOR_MYSQL -e MYSQL_USER=USUARIO_MYSQL -e MYSQL_PASSWORD=CONTRASEÑA_MYSQL -e MYSQL_DATABASE=BASE_DE_DATOS -e AUTHSECRET=SECRETO_JWT matterwiki

 

Y ya podríamos acceder a la URL de nuestro Matterwiki, desde: “http://DIRECCION_IP:5000/#/setup”, crearemos nuestra primera cuenta con privilegios de administrador dentro de Matterwiki, indicamos nombre, apellido, email y contraseña, pulsamos en “Setup My Account”,

 

Y nada, este sería nuestra vista principal, a la izquierda veremos las categorías, y esto es muy simple, sólo podremos crear más categorías para ordenar nuestro contenido, y lo otro que podremos hacer, pues será crear los documentos en la wiki desde “New Article”,

 

 

Lo dicho, podremos crear las Categorías que necesitemos para ordenar el contenido, así como subir nuestro propio logo para darle un toque más personal o añadir más usuarios para acceder a la wiki. Por cierto, si queréis personalizar también los colores de Matterwiki para poner vuestro color corporativo, necesitaréis modificar estos 2 CSS:

/diff/matterwiki/client/assets/bootstrap.css
/diff/matterwiki/client/assets/style.css

 

 

Este sería un pantallazo de cómo es el interfaz para crear posts en nuestra Wiki corporativa, es muy simplón, sencillo…

 

Este sería un pantallazo de cómo quedaría un documento en la Wiki para su consulta posterior, podremos editarlo y repasar su historial de modificaciones si fuese necesario.

 

 

Y este último pantallazo sería de la pantalla inicial, donde podremos ver los últimos documentos, podremos navegar por las categorías o directamente usando el botón de búsqueda podremos localizar rápidamente cualquier artículo.

 

 

Héctor Herrero

Autor del blog Bujarra.com
Cualquier necesidad que tengas, no dudes en contactar conmigo, os intentare ayudar siempre que pueda, compartir es vivir 😉 . Disfrutar de los documentos!!!