Update required environment variables documentation

Abierto Apto para principiantes
#47 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
84/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo

Línea de trabajo

El issue enlaza a content/docs/environment-variables.mdx, concretamente a la sección que describe DATABASE_URL como la única variable obligatoria. Lee esa sección y comprueba los detalles de la versión 3.5.0 de Umami citados en el issue. Actualiza la documentación de las variables obligatorias para incluir APP_SECRET y las instrucciones para generarlo; la tarea estará completada cuando la documentación ya no afirme que DATABASE_URL es la única variable obligatoria.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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)
Lenguaje dominante
MDX
Estrellas
6
Forks
34
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de umami-software/docs

Todos los issues de umami-software/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.