Confusing statement about .env and env_file in dockerComposeFile docs

Ouverte
#738 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
48/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Calme
Stack technique
docker-compose
Domaine
documentation

Piste de recherche

Commencez par la documentation de la propriété dockerComposeFile dans la référence JSON à l’adresse containers.dev/implementors/json_reference/. Comparez l’affirmation concernant .env et env_file avec les deux références Docker Compose liées, puis révisez-la afin que l’interpolation, les variables d’environnement du conteneur et le passage explicite de .env soient clairement distingués ; le travail est considéré comme terminé lorsque la documentation n’implique plus que env_file transmet automatiquement .env au conteneur.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

The statement that describes the dockerComposeFile property in devcontainer.json (https://containers.dev/implementors/json_reference/):

"The default .env file is picked up from the root of the project, but you can use env_file in your Docker Compose file to specify an alternate location."

seems confusing as it refers to two different things.

See: https://stackoverflow.com/questions/79305196/docker-compose-file-is-not-using-env-variables

.env file: used for interpolation in the Compose file and to configure some configs. Variables here can be passed individually to the container via the environment attribute (e.g., LANG=${LANG}), or passed as a whole via the env_file.
see: https://docs.docker.com/compose/how-tos/environment-variables/variable-interpolation/#env-file

env_file: sets the container's environment; this does not pass the .env file automatically into the container unless explicitly passed like (- path: .env).
see: https://docs.docker.com/compose/how-tos/environment-variables/set-environment-variables/#use-the-env_file-attribute

Langage dominant
Aucune donnée de langage
Étoiles
5.8k
Forks
509
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de devcontainers/spec

Toutes les issues de devcontainers/spec

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.