nodeSolidServer / nodeSolidServer/node-solid-server
Docker image defaults to loading ssl cert/key from environment variables
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 1.8k
- Fork
- 308
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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!
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla sezione Docker del README e confrontala con le definizioni delle variabili d’ambiente in docker-image/src/Dockerfile alle righe 23–24. Documenta che queste variabili sono impostate dall’immagine e che per sovrascriverle sono necessari CLI flags invece dei valori del file di configurazione. Non viene menzionato alcun test; il lavoro è completato quando la configurazione Docker e il comportamento di precedenza sono chiari per i lettori.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- docker, javascript
- Ambito
- devops, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100