Update required environment variables documentation

Aperta Adatta ai principianti
#47 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
84/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

L’issue rimanda a content/docs/environment-variables.mdx, in particolare alla sezione che descrive DATABASE_URL come l’unica variabile obbligatoria. Leggi quella sezione e verifica i dettagli della versione 3.5.0 di Umami citati nell’issue. Aggiorna la documentazione delle variabili obbligatorie includendo APP_SECRET e le istruzioni per generarlo; il lavoro è completato quando la documentazione non afferma più che DATABASE_URL è l’unica variabile obbligatoria.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

In Umami 3.5.0, a new variable became required, APP_SECRET. Previously it was only DATABASE_URL, documented as "This is the only required variable.":

https://github.com/umami-software/docs/blob/1460232d912a8f83402a7e2920b6e139963ec8f7/content/docs/environment-variables.mdx?plain=1#L60-L68

The documentation must be updated, since DATABASE_URL is no longer the only required variable, APP_SECRET is also required, everyone failing to provide that will have Umami error with:

⨯ Failed to preload entries: Error: An error occurred while loading instrumentation hook: APP_SECRET must be set to a non-empty secret and cannot use the default placeholder. Generate one with "openssl rand -hex 32" and set APP_SECRET in your environment or .env file.
    at <unknown> (.next/server/chunks/_1xzz-0tjw-9km._.js:1:6882)
    at Module.register (.next/server/chunks/_1xzz-0tjw-9km._.js:1:7070)
Lingua principale
MDX
Stelle
6
Fork
34
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di umami-software/docs

Tutte le issue di umami-software/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.