nodeSolidServer / nodeSolidServer/node-solid-server

Docker image defaults to loading ssl cert/key from environment variables

Abierto
#1,453 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
JavaScript
Estrellas
1.8k
Forks
308
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

For configuration of n-s-s, the readme file specifies

CLI flags take precedence over Environment variables, which take precedence over entries in the config file.

I see that the Dockerfile uses environment variables to specify the ssl cert and key:
https://github.com/solid/node-solid-server/blob/ca5bffbf2299a334eb6c5b7d26b37458df8f6624/docker-image/src/Dockerfile#L23-L24

This caused me some confusion when I first tried to configure the cert and key using the config file. It continued to use the values from the env variables over my config file. I was able to override this with a flag.

I think it'd be a good idea to indicate in the docker section of the readme that these environment variables are set, and that if you want to override them you must use the flag rather than the config file.

I initially had a large draft ticket written for this problem, until I found the Dockerfile environment variable and looked at the documentation again and found the section about precedence. I thought I was going crazy because it was loading some values from the config file but not others. I wonder if it could be made clearer, either in debug output, or the documentation about this precedence (for example during debug the server could output something like 'using config setting x from [cli|env|config]'

Thanks!

Guía de contribución

Abrir la guía de contribución

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.

Línea de trabajo

Comienza con la sección de Docker del README y compárala con las definiciones de las variables de entorno en docker-image/src/Dockerfile, en las líneas 23–24. Documenta que estas variables las establece la imagen y que se requieren CLI flags para sobrescribirlas, en lugar de valores del archivo de configuración. No se menciona ninguna prueba; se considera terminado cuando la configuración de Docker y el comportamiento de precedencia sean claros para los lectores.

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

Evaluación

Stack tecnológico
docker, javascript
Área
devops, documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.