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

Documentation in readme for allowed parameter values #579

Open
jmlord opened this issue Jan 24, 2024 · 1 comment
Open

Documentation in readme for allowed parameter values #579

jmlord opened this issue Jan 24, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@jmlord
Copy link
Contributor

jmlord commented Jan 24, 2024

It would be great to include the allowed parameter values in the GitHub read-me. When setting parameters for a production server I had to guess or search many of them in the Discourse forum for that kind of information.

Example of questions that this documentation would avoid:

  • --api-keys is a flag. On the command line it's obvious. But when using LT_API_KEYS, is defining it enough? Should I put true?
  • Is LT_REQUIRE_API_KEY_ORIGIN a toggle, with the origin automatically detected? Or a string? I which case, can I put a wildcard there such as *.mydomain.com ?
@github-actions github-actions bot added the enhancement New feature or request label Jan 24, 2024
@pierotofy
Copy link
Member

pierotofy commented Jan 25, 2024

I think any value with LT_API_KEYS will do (e.g. LT_API_KEYS=ON or LT_API_KEYS=1).

LT_REQUIRE_API_KEY_ORIGIN is a string (regex), so to match a wildcard it should be something like .*.mydomain.com

if re.match(args.require_api_key_origin, request.headers.get("Origin", ""):

We'd love help improving the README.

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

No branches or pull requests

2 participants