Come installare l'editor di collaborazione Etherpad su Ubuntu 24.04 Server

Etherpad è un editor di testo collaborativo e in tempo reale open-source per il tuo team, accessibile da qualsiasi luogo e in qualsiasi momento perché Etherpad è un editor di testo basato sul web. Etherpad supporta il versioning e la formattazione integrata per i team e offre un editor altamente personalizzabile con il supporto di vari plugin. Supporta anche formati di documento moderni come doc, pdf, odt, markdown, ecc.

In questa guida, ti guideremo attraverso il processo di installazione dell’editor di collaborazione Etherpad sul server Ubuntu 24.04. Configurerai Etherpad con il server di database MariaDB, Nginx come reverse proxy, quindi proteggerai Etherpad con HTTPS tramite Certbot e Letsencrypt.

Prerequisiti

Per iniziare con questa guida, assicurati di avere quanto segue:

Un server Ubuntu 24.04.
Un utente non root con privilegi di amministratore.
Un nome di dominio puntato a un indirizzo IP del server.

Installazione delle dipendenze

Etherpad è un editor collaborativo in tempo reale scritto in Node.js. Per installarlo, devi installare le dipendenze dei pacchetti come Node.js, NPM e Git. Etherpad richiede anche Python3 e MySQL/MariaDB per il database.

Per prima cosa, aggiorna il tuo repository Ubuntu con il seguente comando:

sudo apt update

Ora, installa le dipendenze per Etherpad utilizzando il comando qui sotto. Con questo comando, installerai il server MariaDB, Nginx, Node.js, Python3, Git e alcuni strumenti essenziali.

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

Digita Y per confermare l’installazione.

Dopo l’installazione, controlla i servizi MariaDB e Nginx per assicurarti che entrambi i servizi siano in esecuzione.

Controlla il servizio MariaDB con il seguente comando:

sudo systemctl is-enabled mariadb  
sudo systemctl status mariadb

Come puoi vedere qui sotto, il servizio MariaDB è in esecuzione e si avvierà automaticamente all’avvio.

Ora controlla il servizio Nginx utilizzando il comando qui sotto. Dovresti ottenere un output simile quando il servizio Nginx è in esecuzione e abilitato.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Infine, controlla la versione di Node.js con il comando.

node -v

Assicurati di avere Node.js v18.x o superiore. Etherpad supporta Node.js v18 e versioni successive.

Configurazione del server MariaDB

Dopo aver installato le dipendenze, configurerai il server MariaDB e creerai un nuovo database e un utente per Etherpad. Proteggerai MariaDB utilizzando l’utilità ‘mariadb-secure-installation’, quindi configurerai il database e l’utente tramite il client MariaDB.

Per proteggere il tuo server MariaDB, esegui il seguente comando:

sudo mariadb-secure-installation

Ti verrà chiesto di configurare il server MariaDB:

1. L’installazione predefinita di MariaDB viene fornita senza una password, premi INVIO quando ti viene chiesta la password.
2. Ora inserisci Y per impostare la password di root di MariaDB. Quindi, digita la nuova password per MariaDB e ripeti la password.
3. Inserisci Y per rimuovere l’utente anonimo dalla tua installazione di MariaDB.
4. Inserisci Y di nuovo quando ti viene chiesto di disabilitare il login remoto per l’utente root di MariaDB.
5. Inserisci Y per rimuovere il database di test predefinito dalla tua installazione di MariaDB.
6. Infine, inserisci Y per ricaricare i privilegi delle tabelle e applicare le nuove modifiche.

Dopo aver protetto e configurato il server MariaDB, creerai un nuovo database e un utente per Etherpad.

Accedi al server MariaDB con il seguente comando. Inserisci la password di root di MariaDB quando richiesto.

sudo mariadb -u root -p

Successivamente, esegui le seguenti query MariaDB per creare un nuovo database ‘etherpad_db‘, un utente ‘etherpad‘, con la password ‘StrongPasswordEtherpadDB‘. Puoi modificare i dettagli del database qui sotto con le tue informazioni.

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;

Ora esegui la seguente query per assicurarti che l’utente ‘etherpad‘ possa accedere al database ‘etherpad_db‘.

SHOW GRANTS FOR etherpad@localhost;

Puoi vedere qui sotto l’utente ‘etherpad‘ con più privilegi sul database ‘etherpad_db‘.

Infine, digita quit per uscire dal server MariaDB.

Installazione di Etherpad Lite

Dopo aver creato il database e l’utente, scaricherai il codice sorgente di Etherpad, installerai le dipendenze di Etherpad con lo script di installazione e poi configurerai l’installazione di Etherpad con il server MariaDB.

Per impostazione predefinita, Etherpad utilizza il gestore di pacchetti pnpm per gestire l’installazione, quindi devi prima installare ‘pnpm’ globalmente nel tuo sistema.

Per prima cosa, installa il pacchetto pnpm globalmente (-g) utilizzando il seguente comando npm. Per impostazione predefinita, il progetto Etherpad utilizza pnpm come gestore di pacchetti Node.js invece del normale npm.

npm install pnpm -g

Ora esegui il comando qui sotto per creare un nuovo utente di sistema ‘etherpad‘. Questo utente sarà utilizzato per eseguire l’applicazione Etherpad.

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

Successivamente, vai in /opt e scarica il codice sorgente di Etherpad nella directory ‘etherpad-lite‘ con git. Quindi, cambia la proprietà della directory ‘/opt/etherpad-lite‘ all’utente ‘etherpad‘.

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

Dopo, vai nella directory ‘opt/etherpad-lite’ e installa le dipendenze di Node.js per Etherpad con il seguente comando.

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

Di seguito è riportato il processo di download delle dipendenze di Etherpad utilizzando il gestore di pacchetti pnpm.

Dopo che le dipendenze sono state installate, Etherpad dovrebbe essere in esecuzione automaticamente. Puoi vedere qui sotto che Etherpad 2.0.3 è in esecuzione.

Premi Ctrl+c per terminare l’attuale processo di Etherpad. Configurerai Etherpad con il database MariaDB.

Ora apri il file ‘settings.json‘ con il seguente editor nano.

nano settings.json

Cambia il titolo per la tua installazione di Etherpad.

 "title": "Etherpad Ubuntu 24",

Cambia l’indirizzo IP predefinito in 12.0.0.1 o localhost. Questo avvierà il processo di Etherpad solo in localhost.

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

Commenta la configurazione del database predefinito ‘dirty‘ come segue:

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

Inserisci la configurazione qui sotto per impostare un database con il server MariaDB. Assicurati di modificare i dettagli delle informazioni del database con i tuoi.

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

Quando hai finito, salva il file ed esci dall’editor.

Esecuzione di Etherpad come servizio systemd

Ora che hai installato e configurato Etherpad, creerai un nuovo file di servizio systemd per Etherpad. Con questo, eseguirai Etherpad in background e potrai gestire Etherpad tramite il comando ‘systemctl’.

Crea un nuovo file di servizio systemd per Etherpad ‘/etc/systemd/system/etherpad.service‘ con l’editor nano.

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

Aggiungi la seguente configurazione al file. Con questo, eseguirai Etherpad in background come servizio systemd tramite il comando ‘pnpm’.

[Unit]  
Description=Etherpad-lite, l'editor collaborativo.  
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 più un settings.json completo per evitare il tempo di attesa del servizio, pianificando il riavvio.  
Restart=always  
  
[Install]  
WantedBy=multi-user.target

Salva il file ed esci.

Ora esegui il comando qui sotto per ricaricare il gestore systemd e applicare il file di servizio Etherpad.

sudo systemctl daemon-reload

Dopo che systemd è stato ricaricato, avvia e abilita il servizio ‘etherpad’ con il seguente comando systemctl.

sudo systemctl start etherpad  
sudo systemctl enable etherpad

Successivamente, esegui il comando qui sotto per controllare lo stato del servizio Etherpad e assicurati che il servizio sia in esecuzione.

sudo systemctl status etherpad

Puoi vedere qui sotto che il servizio Etherpad è in esecuzione come servizio.

Infine, controlla la porta predefinita di Etherpad 9001 con il comando ‘ss’ qui sotto. Dovresti vedere che la porta 9001 è utilizzata dal processo di Etherpad.

ss -tulpn | grep 9001

Configurazione di Nginx come reverse proxy

Eseguirai Etherpad con Nginx come reverse proxy in questa guida. Quindi ora creerai la configurazione del blocco del server Nginx per Etherpad e assicurati di aver preparato il tuo nome di dominio per Etherpad.

Usa il seguente comando dell’editor nano per creare un nuovo blocco del server Nginx ‘/etc/nginx/sites-available/etherpad.conf’.

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

Aggiungi la seguente configurazione e modifica l’opzione server_name con il tuo nome di dominio. Con questa configurazione, utilizzerai Nginx come reverse proxy per Etherpad, che gira sulla porta 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; # fai attenzione, questa riga non sovrascrive alcun proxy_buffering on impostato in un conf.d/file.conf  
 proxy_set_header Host $host;  
 proxy_pass_header Server;  
# Nota che potresti voler passare anche questi header ecc.  
 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 per mostrare il reale IP remoto  
 proxy_set_header X-Forwarded-Proto $scheme; # per EP per impostare il flag del cookie sicuro quando viene utilizzato https  
 proxy_http_version 1.1; # raccomandato con connessioni keepalive  
# WebSocket proxying - da https://nginx.org/en/docs/http/websocket.html  
 proxy_set_header Upgrade $http_upgrade;  
 proxy_set_header Connection "upgrade";  
 }  
  
}

Salva e chiudi il file quando hai finito.

Ora esegui il comando qui sotto per attivare il file del blocco del server ‘etherpad.conf‘ e verificare la sintassi di Nginx.

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

Dovresti ottenere un output ‘nginx is ok…test is successful‘ con la corretta sintassi di Nginx.

Infine, esegui il comando qui sotto per riavviare il servizio Nginx e applicare il tuo nuovo blocco del server. Dopo aver eseguito il comando, il tuo Etherpad sarà accessibile tramite il server web Nginx.

sudo systemctl restart nginx

Proteggere Etherpad con HTTPS

Dopo aver configurato il reverse proxy Nginx, proteggerai Etherpad con HTTPS. Se stai utilizzando un dominio pubblico, puoi utilizzare i seguenti passaggi per impostare HTTPS con Certbot e Letsencrypt. Gli utenti di domini locali possono utilizzare certificati autofirmati.

Installa Certbot e il plugin Certbot Nginx utilizzando il seguente comando. Quando richiesto, digita Y per confermare l’installazione.

sudo apt install certbot python3-certbot-nginx

Ora esegui il seguente comando certbot per generare certificati SSL/TLS da Letsencrypt. Assicurati di modificare il nome di dominio e l’indirizzo email con i tuoi dettagli.

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

Dopo aver completato il processo, i tuoi certificati saranno disponibili nella directory ‘/etc/letsencrypt/live/domain.com‘. Inoltre, la tua installazione di Etherpad dovrebbe essere eseguita automaticamente con HTTPS tramite il plugin Certbot Nginx.

Accesso a Etherpad

Visita il tuo nome di dominio Etherpad https://etherpad.howtoforge.local per accedere alla tua installazione di Etherpad. Se hai successo, vedrai la seguente pagina:

Digita il nuovo nome per il tuo primo pad e fai clic su OK per confermare.

Ora vedrai l’editor di documenti per Etherpad. Puoi ora modificare il documento contemporaneamente ai tuoi amici o colleghi.

Conclusione

Congratulazioni! Hai installato l’editor di collaborazione Etherpad sul server Ubuntu 24.04. Hai Etherpad in esecuzione con il server di database MariaDB e il server web Nginx. Inoltre, hai protetto Etherpad con HTTPS tramite Certbot e Letsencrypt.