Cómo auto-hospedar HedgeDoc en un VPS (Guía Completa)

Introducción

HedgeDoc es un editor de markdown colaborativo que permite a múltiples usuarios editar documentos en tiempo real. A menudo se utiliza para tomar notas y documentación entre equipos. Auto-hospedar HedgeDoc en un Servidor Privado Virtual (VPS) te brinda control total sobre tus datos y garantiza la privacidad. En esta guía, te guiaremos a través de los pasos para instalar HedgeDoc en un VPS utilizando Docker.

Requisitos Previos

1. Un VPS: Elige un proveedor de VPS adecuado. Aquí tienes una comparación rápida de algunas opciones populares:

Para comparaciones detalladas de varios proveedores de VPS, consulta nuestra comparación completa de VPS.

2. Acceso SSH: Asegúrate de poder acceder a tu VPS a través de SSH.

3. Docker y Docker Compose: Asegúrate de que tanto Docker como Docker Compose estén instalados en tu VPS. Puedes instalarlos utilizando los siguientes comandos:

   sudo apt update
   sudo apt install -y docker.io docker-compose

Paso 1: Configuración del Entorno de HedgeDoc

1. Crea un directorio para HedgeDoc:

   mkdir ~/hedgedoc
   cd ~/hedgedoc

2. Crea un archivo docker-compose.yml en el directorio hedgedoc. Agrega la siguiente configuración para configurar HedgeDoc con PostgreSQL como base de datos:

   version: '3.1'
   
   services:
     hedgedoc:
       image: hedgedoc/hedgedoc:latest
       environment:
         - CMD_URI=https://tu-dominio.com
         - DB_TYPE=postgres
         - DB_HOST=db
         - DB_PORT=5432
         - DB_USER=hedgedoc
         - DB_PASS=hedgedoc_password
         - DB_NAME=hedgedoc
       ports:
         - '3000:3000'
       depends_on:
         - db
   
     db:
       image: postgres:latest
       environment:
         - POSTGRES_USER=hedgedoc
         - POSTGRES_PASSWORD=hedgedoc_password
         - POSTGRES_DB=hedgedoc
       volumes:
         - db_data:/var/lib/postgresql/data
   
   volumes:
     db_data:

3. Reemplaza tu-dominio.com con el dominio real que usarás para acceder a HedgeDoc.

Paso 2: Ejecutando HedgeDoc

1. Inicia la aplicación HedgeDoc usando Docker Compose:

   docker-compose up -d

2. Verifica que HedgeDoc se esté ejecutando correctamente revisando los registros:

   docker-compose logs -f

3. Por defecto, HedgeDoc será accesible en http://tu-ip-del-servidor:3000. Querrás configurar un proxy inverso para un entorno de producción.

Paso 3: Configuración de un Proxy Inverso con Nginx

1. Instala Nginx:

   sudo apt install -y nginx

2. Crea un nuevo archivo de configuración para HedgeDoc:

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

3. Agrega la siguiente configuración:

   server {
       listen 80;
       server_name tu-dominio.com;
   
       location / {
           proxy_pass http://localhost:3000;
           proxy_set_header Host $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;
       }
   }

4. Habilita la configuración:

   sudo ln -s /etc/nginx/sites-available/hedgedoc /etc/nginx/sites-enabled/
   sudo nginx -t
   sudo systemctl restart nginx

Paso 4: Asegurando HedgeDoc con SSL

1. Para asegurar tu instancia de HedgeDoc, puedes usar Let’s Encrypt. Instala Certbot:

   sudo apt install -y certbot python3-certbot-nginx

2. Ejecuta Certbot para obtener SSL para tu dominio:

   sudo certbot --nginx -d tu-dominio.com

Preguntas Frecuentes

1. ¿Cuáles son los beneficios de auto-hospedar HedgeDoc?

Auto-hospedar HedgeDoc te otorga un control sin igual sobre tus datos y privacidad. A diferencia de las opciones basadas en la nube, al auto-hospedar, tú gestionas las actualizaciones de seguridad y las personalizaciones según tus necesidades. Esta configuración es crucial para desarrolladores y aficionados a los laboratorios en casa que requieren cumplimiento con procesos específicos de manejo de datos o desean integrar HedgeDoc en sistemas más amplios de manera fluida.

2. ¿Puedo ejecutar HedgeDoc en un VPS de especificaciones bajas?

Sí, HedgeDoc puede funcionar eficientemente en un VPS de especificaciones bajas, siempre y cuando cumpla con los requisitos del sistema. Para operaciones básicas, un VPS con 2 GB de RAM y espacio en disco mínimo es suficiente. Sin embargo, para instancias más grandes o colaboraciones con múltiples usuarios, considera un VPS con al menos 4 GB de RAM y 50 GB de espacio en disco para asegurar un rendimiento fluido. La estructura de precios de proveedores como Contabo y Hetzner puede satisfacer esta necesidad de manera asequible.

3. ¿Cómo actualizo mi instalación de HedgeDoc?

Actualizar HedgeDoc es sencillo debido a su configuración con Docker. Puedes obtener la última imagen y reiniciar los contenedores. Aquí tienes el comando para hacerlo:

docker-compose pull
docker-compose up -d

Después de ejecutar estos comandos, debes consultar regularmente las notas de lanzamiento de HedgeDoc para cualquier cambio o pasos de migración necesarios para garantizar un funcionamiento fluido. Puedes consultar la documentación de HedgeDoc para obtener detalles específicos sobre las actualizaciones de versión.

Conclusión

Auto-hospedar HedgeDoc en un VPS te permite beneficiarte de un poderoso editor de markdown mientras mantienes el control sobre tu entorno. Con los pasos de configuración descritos arriba, ahora deberías poder instalar, configurar y asegurar HedgeDoc de manera efectiva. Disfruta de la colaboración en tiempo real sin comprometer la privacidad o la integridad de los datos.