← Torna a Gitdeck web

GITDECK WEB / INSTALLAZIONE

La tua dashboard.
Sul tuo server.

Avvia Gitdeck sul tuo computer o su un server che gestisci tu. Con Docker Compose, app e dati trovano il loro posto in pochi passaggi.

Guida basata sul 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

Un accesso che resta tuo.

La configurazione Docker del progetto usa una OAuth App GitHub con Device Flow. Creala una volta: ti serve soltanto il 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 il link di autorizzazione GitHub. Approva l'accesso nel browser: il token viene conservato dal server e non viene esposto al frontend.

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 dati restano al loro posto.

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

La build di produzione serve API e interfaccia da http://127.0.0.1:8765. Token e snapshot vengono conservati in ~/.gitdeck/.

Vuoi lavorare sul codice?

Dopo npm install e l'esportazione del Client ID, avvia la modalità sviluppo:

Terminale

npm run dev

L'interfaccia è 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, usa il selettore degli account per aggiungere GitLab o Forgejo, incluse le tue istanze. Per GitLab puoi usare un token personale con scope api; per Forgejo inserisci il token e l'indirizzo dell'istanza. Funzioni e dati dipendono dai permessi del provider.

Con Compose, modifica .env per impostare le variabili supportate dal file incluso e ricrea il container. Con Node.js, esporta le variabili nell'ambiente del processo. L'AI è opzionale.

VariabileUso
GITHUB_CLIENT_IDRichiesto per Device FlowClient ID della tua OAuth App GitHub.
GITHUB_OAUTH_SCOPESOpzionalePermessi GitHub. Default: repo read:org project read:user user:email.
OPENAI_API_KEYOpzionaleAbilita i riepiloghi AI nella dashboard. Le altre funzioni restano disponibili senza.
OPENAI_DIGEST_MODELOpzionaleModello per i riepiloghi AI. Default: gpt-4.1-mini.
GH_AUTH_MODEAvvio manualedevice (default), gh-cli oppure token. Il Compose incluso usa Device Flow.
HOST / PORTAvvio manualeIndirizzo e porta del server. Default: 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

Ferma i container, 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