-
Notifications
You must be signed in to change notification settings - Fork 65
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
docs: envs documentation #49
Conversation
…E-4552 When using a CDN we want to make sure that we do not use a long cache duration for endpoints like `/current_block` and `/height` where the response changes as each new block is produced. This change adds a Cache-Control max-age of 30 seconds for all proxied requests. In the future we will adjust this to be route specific (responses for block and TX by ID can be cached longer).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can add
LOG_FORMAT | string | "simple" | sets the format of output logs, accepts "simple" and "json"
INSTANCE_ID | string | "" | Adds an "instanceId" field to output logs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added the missing ENVs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wrapping the values for ANS104_UNBUNDLE_FILTER and ANS104_INDEX_FILTER in single quotes can lead to parsing errors. The values do not need to be wrapped in any quotes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed the single quotes.
This PR should resolve the #47 issue.
I've noticed that the ENVs are quite well documented in the official docs. So I've just created a
.env.example
file with all possible ENVs and their description.I've also created an
env.md
file where all the ENVs are specified in the markdown table. It's up to you if you want to use the table in some different place in the docs.I've heard that @Bobinstein is working on docs, so his feedback will be more than appreciated.