nodeSolidServer / nodeSolidServer/node-solid-server
Docker image defaults to loading ssl cert/key from environment variables
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 1.8k
- Forks
- 308
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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!
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit dem Docker-Abschnitt der README und vergleichen Sie ihn mit den Definitionen der Umgebungsvariablen in docker-image/src/Dockerfile in den Zeilen 23–24. Dokumentieren Sie, dass diese Variablen vom Image gesetzt werden und dass zum Überschreiben dieser Variablen CLI flags anstelle von Werten aus der Konfigurationsdatei erforderlich sind. Kein Test wird erwähnt; als abgeschlossen gilt die Aufgabe, wenn die Docker-Konfiguration und das Prioritätsverhalten für Leser klar sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- docker, javascript
- Bereich
- devops, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100