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

Added support environment variables #14

Merged
merged 1 commit into from
Aug 12, 2024

Conversation

ezrasingh
Copy link
Owner

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Key Changes

  • Environment Variable Documentation: Added detailed explanations of the environment variables GEOPROX_CONFIG, GEOPROX_HTTP_ADDR, and GEOPROX_HTTP_PORT in the documentation, highlighting their default values and usage.
  • Environment Variable Precedence: Clarified that environment variables take precedence over configuration files, ensuring users understand the order of operations when both are present.

Related Tickets & Documents

QA Instructions, Screenshots, Recordings

  • Verify that the environment variables are correctly documented in the project's documentation.
  • Test the behavior by setting the environment variables and observing that they override the values in the configuration files as expected.

Added/updated tests?

  • Yes
  • No, and this is why: Documentation changes do not require additional tests.
  • I need help with writing tests

@ezrasingh ezrasingh added bug Something isn't working documentation Improvements or additions to documentation labels Aug 12, 2024
@ezrasingh ezrasingh added this to the v1.0.0 milestone Aug 12, 2024
@ezrasingh ezrasingh linked an issue Aug 12, 2024 that may be closed by this pull request
@ezrasingh ezrasingh self-assigned this Aug 12, 2024
@ezrasingh ezrasingh merged commit 4b80ce6 into main Aug 12, 2024
6 checks passed
@ezrasingh ezrasingh deleted the 6-missing-docs-on-environment-variables branch August 12, 2024 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Missing Docs On Environment Variables
1 participant