Skip to content

docs: add docs to list all possible CODER_ env variables #6002

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

Closed
matifali opened this issue Feb 2, 2023 · 9 comments
Closed

docs: add docs to list all possible CODER_ env variables #6002

matifali opened this issue Feb 2, 2023 · 9 comments

Comments

@matifali
Copy link
Member

matifali commented Feb 2, 2023

Add docs to list all possible CODER_ env variables that can be set in /etc/coder.d/coder.env
cc: @bpmct @ammario

@bpmct
Copy link
Member

bpmct commented Feb 2, 2023

We technically have it here, but it's not fantastic to browse. https://coder.com/docs/v2/latest/cli/coder_server

@BrunoQuaresma - thoughts on doing the CLI arguments via a table format?

@bpmct
Copy link
Member

bpmct commented Feb 2, 2023

Could also be nice to make each flag linkable

@matifali
Copy link
Member Author

matifali commented Feb 2, 2023

Is there a relationship between --some-feature and CODER_SOME_FEATURE?
There are cases where this does not match.
e.g.
--telemetry and CODER_TELEMETRY_ENABLE
--cache-dir and CODER_CACHE_DIRECTORY

@bpmct
Copy link
Member

bpmct commented Feb 3, 2023

There usually is a direct relationship, but there are edge cases!

@matifali
Copy link
Member Author

matifali commented Feb 3, 2023

Ok. I thought it might be a typo.

@ammario
Copy link
Member

ammario commented Feb 3, 2023

We should do a better job of making these consistent so they're easier to remember. Let's look at redoing the environment variables to match the flags, silently accepting the old variables for compatibility.

@bpmct
Copy link
Member

bpmct commented Feb 3, 2023

Related #5290

@bpmct
Copy link
Member

bpmct commented Feb 3, 2023

added #5290 to our backlog. we should still think about ways we can make the CLI output (+ docs) prettier as well :)

@bpmct
Copy link
Member

bpmct commented Feb 8, 2023

closing in favor of #6055

@bpmct bpmct closed this as completed Feb 8, 2023
@bpmct bpmct closed this as not planned Won't fix, can't repro, duplicate, stale Feb 8, 2023
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

3 participants