Cómo instalar el editor de colaboración Etherpad en el servidor Ubuntu 24.04

Etherpad es un editor de texto colaborativo y en tiempo real de código abierto para tu equipo, accesible desde cualquier lugar en cualquier momento porque Etherpad es un editor de texto basado en la web. Etherpad soporta versionado y formato incorporado para equipos y ofrece un editor altamente personalizable con el soporte de varios complementos. También soporta formatos de documento modernos como doc, pdf, odt, markdown, etc.

En esta guía, te guiaremos a través del proceso de instalación del editor de colaboración Etherpad en el servidor Ubuntu 24.04. Configurarás Etherpad con el servidor de base de datos MariaDB, Nginx como proxy inverso, y luego asegurarás Etherpad con HTTPS a través de Certbot y Letsencrypt.

Requisitos previos

Para comenzar con esta guía, asegúrate de tener lo siguiente:

Un servidor Ubuntu 24.04.
Un usuario no root con privilegios de administrador.
Un nombre de dominio apuntando a una dirección IP del servidor.

Instalando dependencias

Etherpad es un editor colaborativo en tiempo real escrito en Node.js. Para instalarlo, debes instalar dependencias de paquetes como Node.js, NPM y Git. Etherpad también requiere Python3 y MySQL/MariaDB para la base de datos.

Primero, actualiza tu repositorio de Ubuntu con lo siguiente:

sudo apt update

Ahora, instala las dependencias para Etherpad usando el siguiente comando. Con este comando, instalarás el servidor MariaDB, Nginx, Node.js, Python3, Git y algunas herramientas esenciales.

sudo apt install mariadb-server nginx nodejs npm gzip git curl python3 libssl-dev

Escribe Y para confirmar la instalación.

Después de la instalación, verifica los servicios de MariaDB y Nginx para asegurarte de que ambos servicios estén en funcionamiento.

Verifica el servicio de MariaDB con lo siguiente:

sudo systemctl is-enabled mariadb  
sudo systemctl status mariadb

Como puedes ver a continuación, el servicio de MariaDB está en funcionamiento y se iniciará automáticamente al arrancar.

Ahora verifica el servicio de Nginx usando el siguiente comando. Deberías obtener una salida similar cuando el servicio de Nginx esté en funcionamiento y habilitado.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Por último, verifica la versión de Node.js con el comando.

node -v

Asegúrate de tener Node.js v18.x o más. Etherpad soporta Node.js v18 y superior.

Configurando el servidor MariaDB

Después de haber instalado las dependencias, configurarás el servidor MariaDB y crearás una nueva base de datos y usuario para Etherpad. Asegurarás MariaDB usando la utilidad ‘mariadb-secure-installation’, y luego configurarás la base de datos y el usuario a través del cliente de MariaDB.

Para asegurar tu servidor MariaDB, ejecuta lo siguiente:

sudo mariadb-secure-installation

Se te pedirá que configures el servidor MariaDB:

1. La instalación predeterminada de MariaDB viene sin una contraseña, presiona ENTER cuando se te pida la contraseña.
2. Ahora ingresa Y para configurar la contraseña de root de MariaDB. Luego, escribe la nueva contraseña para MariaDB y repite la contraseña.
3. Ingresa Y para eliminar el usuario anónimo de tu instalación de MariaDB.
4. Ingresa Y nuevamente cuando se te pida deshabilitar el inicio de sesión remoto para el usuario root de MariaDB.
5. Ingresa Y para eliminar la base de datos de prueba predeterminada de tu MariaDB.
6. Por último, ingresa Y para recargar los privilegios de las tablas y aplicar los nuevos cambios.

Después de haber asegurado y configurado el servidor MariaDB, crearás una nueva base de datos y usuario para Etherpad.

Inicia sesión en el servidor MariaDB con el siguiente comando. Ingresa la contraseña de root de MariaDB cuando se te pida.

sudo mariadb -u root -p

A continuación, ejecuta las siguientes consultas de MariaDB para crear una nueva base de datos ‘etherpad_db‘, un usuario ‘etherpad‘, con la contraseña ‘StrongPasswordEtherpadDB‘. Puedes ajustar los siguientes detalles de la base de datos con tu información.

CREATE DATABASE etherpad_db;  
CREATE USER etherpad@localhost IDENTIFIED BY 'StrongPasswordEtherpadDB';  
GRANT CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on etherpad_db.* to etherpad@localhost;  
FLUSH PRIVILEGES;

Ahora ejecuta la siguiente consulta para asegurarte de que el usuario ‘etherpad‘ pueda acceder a la base de datos ‘etherpad_db‘.

SHOW GRANTS FOR etherpad@localhost;

Puedes ver a continuación que el usuario ‘etherpad‘ tiene múltiples privilegios sobre la base de datos ‘etherpad_db‘.

Por último, escribe quit para salir del servidor MariaDB.

Instalando Etherpad Lite

Después de crear la base de datos y el usuario, descargarás el código fuente de Etherpad, instalarás las dependencias de Etherpad con el script de instalación y luego configurarás la instalación de Etherpad con el servidor MariaDB.

Por defecto, Etherpad utiliza el gestor de paquetes pnpm para gestionar la instalación, así que primero debes instalar ‘pnpm’ globalmente en tu sistema.

Primero, instala el paquete pnpm globalmente (-g) usando el siguiente comando npm. Por defecto, el proyecto Etherpad utiliza pnpm como gestor de paquetes de Node.js en lugar del npm estándar.

npm install pnpm -g

Ahora ejecuta el siguiente comando para crear un nuevo usuario del sistema ‘etherpad‘. Este usuario se utilizará para ejecutar la aplicación Etherpad.

sudo adduser --system --no-create-home --home=/opt/etherpad-lite --group etherpad

A continuación, ve a /opt y descarga el código fuente de Etherpad en el directorio ‘etherpad-lite‘ con git. Luego, cambia la propiedad del directorio ‘/opt/etherpad-lite‘ al usuario ‘etherpad‘.

cd /opt && git clone --branch master https://github.com/ether/etherpad-lite.git   
sudo chown -R etherpad:etherpad /opt/etherpad-lite

Después, ve al directorio ‘opt/etherpad-lite’ e instala las dependencias de Node.js para Etherpad con lo siguiente.

cd /opt/etherpad-lite  
sudo su -s /bin/bash -c "./bin/run.sh" etherpad

A continuación se muestra el proceso de descarga de las dependencias de Etherpad utilizando el gestor de paquetes pnpm.

Después de que se instalen las dependencias, Etherpad debería estar funcionando automáticamente. Puedes ver a continuación que Etherpad 2.0.3 está en funcionamiento.

Presiona Ctrl+c para terminar el proceso actual de Etherpad. Configurarás Etherpad con la base de datos MariaDB.

Ahora abre el archivo ‘settings.json‘ con el siguiente editor nano.

nano settings.json

Cambia el título de tu instalación de Etherpad.

 "title": "Etherpad Ubuntu 24",

Cambia la dirección IP predeterminada a 12.0.0.1 o localhost. Esto iniciará el proceso de Etherpad solo en localhost.

"ip": "127.0.0.1",  
"port": 9001,   

Comenta la configuración de base de datos ‘ dirty ‘ predeterminada como sigue:

 /*  
 *"dbType": "dirty",  
 *"dbSettings": {  
 * "filename": "var/dirty.db"  
 *},  
 */

Inserta la configuración a continuación para configurar una base de datos con el servidor MariaDB. Asegúrate de cambiar los detalles de la información de la base de datos con los tuyos.

 "dbType" : "mysql",  
 "dbSettings" : {  
 "user": "etherpad",  
 "host": "127.0.0.1",  
 "port": 3306,  
 "password": "StrongPasswordEtherpadDB",  
 "database": "etherpad_db",  
 "charset": "utf8mb4"  
 },

Cuando termines, guarda el archivo y sal del editor.

Ejecutando Etherpad como un servicio systemd

Ahora que has instalado y configurado Etherpad, crearás un nuevo archivo de servicio systemd para Etherpad. Con esto, ejecutarás Etherpad en segundo plano, y podrás gestionar Etherpad a través del comando ‘systemctl’.

Crea un nuevo archivo de servicio systemd para Etherpad ‘ /etc/systemd/system/etherpad.service ‘ con el editor nano.

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

Agrega la siguiente configuración al archivo. Con esto, ejecutarás Etherpad en segundo plano como un servicio systemd a través del comando ‘pnpm’.

[Unit]  
Description=Etherpad-lite, el editor colaborativo.  
After=syslog.target network.target mariadb.service  
  
[Service]  
Type=simple  
User=etherpad  
Group=etherpad  
WorkingDirectory=/opt/etherpad-lite  
ExecStart=/usr/local/bin/pnpm run prod  
# usa mysql más un settings.json completo para evitar el tiempo de espera del servicio, programando reinicio.  
Restart=always  
  
[Install]  
WantedBy=multi-user.target

Guarda el archivo y sal.

Ahora ejecuta el siguiente comando para recargar el gestor systemd y aplicar el archivo de servicio de Etherpad.

sudo systemctl daemon-reload

Después de que systemd se recargue, inicia y habilita el servicio ‘etherpad’ con el siguiente comando systemctl.

sudo systemctl start etherpad  
sudo systemctl enable etherpad

A continuación, ejecuta el siguiente comando para verificar el estado del servicio de Etherpad y asegurarte de que el servicio esté en funcionamiento.

sudo systemctl status etherpad

Puedes ver a continuación que el servicio de Etherpad está en funcionamiento como un servicio.

Por último, verifica el puerto predeterminado de Etherpad 9001 con el comando ‘ss’ a continuación. Deberías ver que el puerto 9001 está siendo utilizado por el proceso de Etherpad.

ss -tulpn | grep 9001

Configurando Nginx como un proxy inverso

Ejecutarás Etherpad con Nginx como un proxy inverso en esta guía. Así que ahora crearás la configuración del bloque del servidor Nginx para Etherpad, y asegúrate de haber preparado tu nombre de dominio para Etherpad.

Usa el siguiente comando del editor nano para crear un nuevo bloque de servidor Nginx ‘/etc/nginx/sites-available/etherpad.conf’.

sudo nano /etc/nginx/sites-available/etherpad.conf

Agrega la siguiente configuración y cambia la opción server_name con tu nombre de dominio. Con esta configuración, usarás Nginx como un proxy inverso para Etherpad, que se ejecuta en el puerto 9001.

server {  
 listen 80;  
 server_name etherpad.howtoforge.local;  
  
 access_log /var/log/nginx/eplite.access.log;  
 error_log /var/log/nginx/eplite.error.log;  
  
location / {  
 proxy_pass http://127.0.0.1:9001;  
 proxy_buffering off; # ten cuidado, esta línea no anula ningún proxy_buffering on establecido en un conf.d/file.conf  
 proxy_set_header Host $host;  
 proxy_pass_header Server;  
# Nota que también podrías querer pasar estos encabezados etc.  
 proxy_set_header X-Real-IP $remote_addr; # https://nginx.org/en/docs/http/ngx_http_proxy_module.html  
 proxy_set_header X-Forwarded-For $remote_addr; # EP logs para mostrar la IP remota real  
 proxy_set_header X-Forwarded-Proto $scheme; # para que EP establezca la bandera de cookie segura cuando se usa https  
 proxy_http_version 1.1; # recomendado con conexiones keepalive  
# Proxy de WebSocket - de https://nginx.org/en/docs/http/websocket.html  
 proxy_set_header Upgrade $http_upgrade;  
 proxy_set_header Connection "upgrade";  
 }  
  
}

Guarda y cierra el archivo cuando termines.

Ahora ejecuta el siguiente comando para activar el archivo del bloque del servidor ‘ etherpad.conf ‘ y verificar la sintaxis de tu Nginx.

sudo ln -s /etc/nginx/sites-available/etherpad.conf /etc/nginx/sites-enabled/  
sudo nginx -t

Deberías obtener una salida ‘nginx is ok…test is successful‘ con la sintaxis de Nginx correcta.

Por último, ejecuta el siguiente comando para reiniciar el servicio de Nginx y aplicar tu nuevo bloque de servidor. Después de ejecutar el comando, tu Etherpad será accesible a través del servidor web Nginx.

sudo systemctl restart nginx

Asegurando Etherpad con HTTPS

Después de configurar el proxy inverso de Nginx, asegurarás Etherpad con HTTPS. Si estás usando el dominio público, puedes usar los siguientes pasos para configurar HTTPS con Certbot y Letsencrypt. Los usuarios de dominios locales pueden usar certificados autofirmados.

Instala Certbot y el complemento Certbot Nginx usando el siguiente comando. Cuando se te pida, escribe Y para confirmar la instalación.

sudo apt install certbot python3-certbot-nginx

Ahora ejecuta el siguiente comando certbot para generar certificados SSL/TLS de Letsencrypt. Asegúrate de cambiar el nombre de dominio y la dirección de correo electrónico con tus detalles.

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

Después de completar el proceso, tus certificados estarán disponibles en el directorio ‘ /etc/letsencrypt/live/domain.com ‘. Además, tu instalación de Etherpad debería ejecutarse automáticamente con HTTPS a través del complemento Certbot Nginx.

Accediendo a Etherpad

Visita tu nombre de dominio de Etherpad https://etherpad.howtoforge.local para acceder a tu instalación de Etherpad. Si es exitoso, obtendrás la siguiente página:

Escribe el nuevo nombre para tu primer pad y haz clic en OK para confirmar.

Ahora verás el editor de documentos para Etherpad. Ahora puedes editar el documento al mismo tiempo que tus amigos o colegas.

Conclusión

¡Felicidades! Has instalado el editor de colaboración Etherpad en el servidor Ubuntu 24.04. Tienes Etherpad funcionando con el servidor de base de datos MariaDB y el servidor web Nginx. Además, has asegurado Etherpad con HTTPS a través de Certbot y Letsencrypt.