← Torna a Gitdeck web

GITDECK WEB / INSTALLAZIONE

La tua dashboard.
Sul tuo server.

Installa la dashboard Gitdeck sul tuo computer o su un server che gestisci tu. Con Docker Compose bastano pochi passaggi per iniziare.

Consulta il README del progetto

Prima di cominciare

Ti servono Git, un account GitHub e Docker con Compose. Docker Desktop include già Compose; su Linux puoi usare il plugin per Docker Engine. Con Docker non serve installare Node.js sul computer.

Installa Docker Compose

Questa guida riguarda la dashboard web. L'app iOS si collega direttamente ai provider e funziona anche senza questa installazione.

01 / GITHUB

Collega il tuo account GitHub.

La configurazione Docker del progetto usa un'applicazione OAuth di GitHub con Device Flow. Devi crearla una sola volta: per configurare Gitdeck ti servirà il suo Client ID.

  1. Apri GitHub Developer settings ↗ e scegli OAuth Apps → New OAuth App.
  2. Assegna un nome, per esempio Gitdeck (local). Per Homepage URL e Authorization callback URL puoi usare http://127.0.0.1:8765.
  3. Registra l'app, attiva Enable Device Flow e salva con Update application.
  4. Copia il Client ID. Non serve generare un client secret.

Al primo avvio, Gitdeck mostra un codice e un link per autorizzare l'accesso a GitHub. Completa l'autorizzazione nel browser: il token viene conservato sul server, senza essere esposto all'interfaccia web.

02 / DOCKER COMPOSE

Pronta a partire, in un container.

Il repository include Dockerfile e docker-compose.yml. Esegui i comandi dal terminale.

Prima di procedere, prepara il Client ID GitHub.

1. Scarica il progetto

Terminale

git clone https://github.com/debba/gitdeck.git
cd gitdeck

2. Crea il file .env

Nella cartella gitdeck, crea un file .env e sostituisci il valore di esempio con il Client ID appena copiato.

.env

GITHUB_CLIENT_ID=Iv1.xxxxxxxxxxxxxxxx

3. Avvia la dashboard

Terminale

docker compose up -d --build

Apri http://127.0.0.1:8765 sul computer su cui hai avviato Docker e completa l'accesso GitHub. La prima build può richiedere qualche minuto.

I tuoi dati, anche dopo un riavvio.

Account e snapshot vengono salvati nel volume gitdeck-data, montato in /home/node/.gitdeck. Il volume mantiene i dati quando il container viene ricreato. La porta pubblicata è 8765.

Su un server remoto, configura HTTPS e limita l'accesso alla tua istanza.

Preferisci usare Docker senza Compose?

Dalla cartella del progetto, con lo stesso file .env:

Terminale

docker build -t gitdeck .
docker run -d --name gitdeck \
  -p 8765:8765 \
  --env-file .env \
  -v gitdeck-data:/home/node/.gitdeck \
  gitdeck

03 / NODE.JS

Anche senza Docker.

Puoi avviare Gitdeck direttamente con Node.js e npm. Usa Node.js 22.12 o successivo, oppure 20.19 o successivo nella serie 20, per rispettare i requisiti di Vite. Esporta il Client ID nel terminale prima dell'avvio.

Terminale

git clone https://github.com/debba/gitdeck.git
cd gitdeck
npm install
export GITHUB_CLIENT_ID=Iv1.xxxxxxxxxxxxxxxx
npm run build
npm start

In produzione, API e interfaccia sono disponibili su http://127.0.0.1:8765. Token e snapshot vengono conservati in ~/.gitdeck/.

Vuoi lavorare sul codice?

Dopo aver eseguito npm install e impostato il Client ID, avvia la modalità di sviluppo:

Terminale

npm run dev

L'interfaccia è disponibile su http://127.0.0.1:5173 e inoltra le richieste API al backend sulla porta 8765.

04 / CONFIGURAZIONE

I tuoi account. Le tue scelte.

Dopo l'accesso, apri il selettore degli account per aggiungere GitLab o Forgejo, anche su istanze che gestisci tu. Per GitLab puoi usare un token personale con il permesso api; per Forgejo, inserisci il token e l'indirizzo dell'istanza. Le funzioni e i dati disponibili dipendono dai permessi concessi dal provider.

Se usi Docker Compose, imposta in .env le variabili supportate dal file docker-compose.yml del progetto, poi ricrea il container. Con Node.js, esporta le variabili nell'ambiente del processo. Puoi scegliere se abilitare l'AI.

VariabileUso
GITHUB_CLIENT_IDRichiesto per Device FlowClient ID della tua applicazione OAuth su GitHub.
GITHUB_OAUTH_SCOPESOpzionalePermessi GitHub. Valore predefinito: repo read:org project read:user user:email.
OPENAI_API_KEYOpzionaleAbilita i riepiloghi AI nella dashboard. Tutte le altre funzioni sono disponibili anche senza questa chiave.
OPENAI_DIGEST_MODELOpzionaleModello per i riepiloghi AI. Valore predefinito: gpt-4.1-mini.
GH_AUTH_MODEAvvio manualedevice (predefinito), gh-cli oppure token. Il file Docker Compose del progetto usa Device Flow.
HOST / PORTAvvio manualeIndirizzo e porta del server. Valori predefiniti: 127.0.0.1 e 8765. Nel container: 0.0.0.0 e 8765.
Tutte le opzioni nel README

05 / GESTIONE

Mantieni la rotta.

Aggiorna dal repository

Terminale

git pull --ff-only
docker compose up -d --build

Controlla stato e log

Terminale

docker compose ps
docker compose logs -f gitdeck

Arresta i container e conserva i dati

Terminale

docker compose down

Il volume persistente rimane disponibile. Per ripartire, esegui di nuovo docker compose up -d. Se usi Node.js, dopo git pull esegui npm install e npm run build, poi riavvia npm start.

Esplora il progetto su GitHub