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

docs: envs documentation #49

Closed
wants to merge 7 commits into from

Conversation

rixcian
Copy link
Contributor

@rixcian rixcian commented Sep 15, 2023

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.

rixcian and others added 5 commits September 14, 2023 10:18
…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).
Copy link
Contributor

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

Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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.

@djwhitt
Copy link
Collaborator

djwhitt commented Sep 25, 2023

Thanks, @rixcian! Rebased and merged. Worth noting I made a couple of minor corrections in the process:

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

Successfully merging this pull request may close these issues.

3 participants