Come Autohostare HedgeDoc su un VPS (Guida Completa)

Introduzione

HedgeDoc è un editor markdown collaborativo che consente a più utenti di modificare documenti in tempo reale. Viene spesso utilizzato per prendere appunti e documentare tra team. L’autohosting di HedgeDoc su un Server Privato Virtuale (VPS) ti offre il pieno controllo sui tuoi dati e garantisce la privacy. In questa guida, ti guideremo attraverso i passaggi per installare HedgeDoc su un VPS utilizzando Docker.

Prerequisiti

1. Un VPS: Scegli un provider VPS adatto. Ecco un confronto rapido di alcune opzioni popolari:

Per confronti dettagliati tra vari provider VPS, controlla il nostro confronto VPS completo.

2. Accesso SSH: Assicurati di poter accedere al tuo VPS tramite SSH.

3. Docker e Docker Compose: Verifica che Docker e Docker Compose siano installati sul tuo VPS. Puoi installarli utilizzando i seguenti comandi:

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

Passo 1: Configurazione dell’Ambiente HedgeDoc

1. Crea una directory per HedgeDoc:

   mkdir ~/hedgedoc
   cd ~/hedgedoc

2. Crea un file docker-compose.yml nella directory hedgedoc. Aggiungi la seguente configurazione per impostare HedgeDoc con PostgreSQL come database:

   version: '3.1'
   
   services:
     hedgedoc:
       image: hedgedoc/hedgedoc:latest
       environment:
         - CMD_URI=https://your-domain.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. Sostituisci your-domain.com con il dominio reale che utilizzerai per accedere a HedgeDoc.

Passo 2: Esecuzione di HedgeDoc

1. Avvia l’applicazione HedgeDoc utilizzando Docker Compose:

   docker-compose up -d

2. Verifica che HedgeDoc stia funzionando correttamente controllando i log:

   docker-compose logs -f

3. Per impostazione predefinita, HedgeDoc sarà accessibile a http://your-server-ip:3000. Dovrai impostare un reverse proxy per un ambiente di produzione.

Passo 3: Configurazione di un Reverse Proxy con Nginx

1. Installa Nginx:

   sudo apt install -y nginx

2. Crea un nuovo file di configurazione per HedgeDoc:

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

3. Aggiungi la seguente configurazione:

   server {
       listen 80;
       server_name your-domain.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. Abilita la configurazione:

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

Passo 4: Sicurezza di HedgeDoc con SSL

1. Per proteggere la tua istanza di HedgeDoc, puoi utilizzare Let’s Encrypt. Installa Certbot:

   sudo apt install -y certbot python3-certbot-nginx

2. Esegui Certbot per ottenere l’SSL per il tuo dominio:

   sudo certbot --nginx -d your-domain.com

Domande Frequenti

1. Quali sono i vantaggi dell’autohosting di HedgeDoc?

L’autohosting di HedgeDoc ti offre un controllo senza pari sui tuoi dati e sulla tua privacy. A differenza delle opzioni basate su cloud, quando autohosti, gestisci gli aggiornamenti di sicurezza e le personalizzazioni secondo le tue esigenze. Questa configurazione è cruciale per sviluppatori e appassionati di homelab che richiedono conformità con processi specifici di gestione dei dati o vogliono integrare HedgeDoc in sistemi più ampi senza problemi.

2. Posso eseguire HedgeDoc su un VPS a bassa specifica?

Sì, HedgeDoc può funzionare in modo efficiente su un VPS a bassa specifica, a patto che soddisfi i requisiti di sistema. Per operazioni di base, un VPS con 2 GB di RAM e spazio disco minimo è sufficiente. Tuttavia, per istanze più grandi o collaborazioni con più utenti, considera un VPS con almeno 4 GB di RAM e 50 GB di spazio disco per garantire prestazioni fluide. La struttura dei prezzi di fornitori come Contabo e Hetzner può soddisfare questa esigenza a un prezzo conveniente.

3. Come posso aggiornare la mia installazione di HedgeDoc?

Aggiornare HedgeDoc è semplice grazie alla sua configurazione Docker. Puoi scaricare l’ultima immagine e riavviare i contenitori. Ecco il comando per farlo:

docker-compose pull
docker-compose up -d

Dopo aver eseguito questi comandi, dovresti controllare regolarmente le note di rilascio di HedgeDoc per eventuali modifiche o passaggi di migrazione richiesti per garantire un funzionamento senza problemi. Puoi fare riferimento alla documentazione di HedgeDoc per dettagli specifici sugli aggiornamenti delle versioni.

Conclusione

Autohostare HedgeDoc su un VPS ti consente di beneficiare di un potente editor markdown mantenendo il controllo sul tuo ambiente. Con i passaggi di configurazione descritti sopra, ora dovresti essere in grado di installare, configurare e proteggere efficacemente HedgeDoc. Goditi la collaborazione in tempo reale senza compromettere la privacy o l’integrità dei dati.