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

clarify env var precedence over config value #71

Open
foohonpie opened this issue Jul 11, 2024 · 0 comments
Open

clarify env var precedence over config value #71

foohonpie opened this issue Jul 11, 2024 · 0 comments

Comments

@foohonpie
Copy link

Environment

  • Elixir version (elixir -v):
    Erlang/OTP 26 [erts-14.1.1] [source] [64-bit] [smp:2:2] [ds:2:2:10] [async-threads:1] [jit:ns]
    Elixir 1.15.7 (compiled with Erlang/OTP 24)

  • Algoliax version (mix deps):
    algoliax 0.7.1 (Hex package) (mix)
    locked at 0.7.1 (algoliax) 399f76a4

The readme says:

Configuration

Algoliax needs only :api_key and :application_id config. These configs can either be on config files or using environment variables ALGOLIA_API_KEY and ALGOLIA_APPLICATION_ID.

However, it isn't clear that env var takes precedence. This can lead to confusion when testing different values in config; a mismatch can occur which would lead to an "403 : Invalid Application-ID or API key" error, the cause of which isn't immediately obvious.

This isn't a bug, but it would be helpful to note the precedence in the readme.

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

1 participant