Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of configuration environment variables #2154

Closed
jmooring opened this issue Jul 25, 2023 · 2 comments
Closed

Document use of configuration environment variables #2154

jmooring opened this issue Jul 25, 2023 · 2 comments

Comments

@jmooring
Copy link
Member

jmooring commented Jul 25, 2023

This list should describe:

  1. How to use environment variables instead of configuration settings (e.g., HUGO_DISABLELANGUAGES, HUGO_CACHEDIR etc.)
  2. Environment variables that do not have a corresponding configuration setting:
  • DART_SASS_BINARY
  • HUGO_ENVIRONMENT
  • HUGO_FILE_LOG_FORMAT
  • HUGO_NUMWORKERMULTIPLIER
  • HUGO_MEMORYLIMIT
  1. Precedence: command line flags override environment variables which override configuration settings (e.g., --cacheDir, then HUGO_CACHEDIR, then cacheDir in site configuration).

Related to item 3, include (somewhere) a list of which config settings can be overridden with a CLI flag.


Edit: Item 2 was addressed by #2420 when documenting HUGO_MEMORYLIMIT in #2434.

@bep
Copy link
Member

bep commented Aug 7, 2023

Note that the

  • first bullet includes every config setting.
  • HUGO_ENV was added to support a common legacy pattern and should not be included in the docs.

@jmooring jmooring changed the title Document the available environment variables Document use of configuration environment variables Aug 8, 2023
jmooring added a commit that referenced this issue Aug 14, 2023
- Fix description list markdown
- Remove reference to HUGO_ENV per #2154
@jmooring
Copy link
Member Author

jmooring commented Nov 7, 2023

This will be addressed with #1888

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants