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: specify and describe all envs in docs #47

Closed
4 tasks
rixcian opened this issue Sep 10, 2023 · 3 comments
Closed
4 tasks

docs: specify and describe all envs in docs #47

rixcian opened this issue Sep 10, 2023 · 3 comments

Comments

@rixcian
Copy link
Contributor

rixcian commented Sep 10, 2023

There's no documentation about the envs the gateway operator can use/edit.

The operator has to look at the config.ts file and find out what envs the gateway is trying to load from the .env file.

I would suggest creating the following:

  • .env.example file, where all possible envs will be specified and describe what they do
  • Specify and describe all envs in the clear table for these files:
    • README.md
    • Official docs (linux-setup.md, windows-setup.md)

The table in markdown could look like this:

ENV_NAME DEFAULT_VALUE DESCRIPTION
START_HEIGHT 0 Starting block height for node synchronization
... ... ...

If you're okay with this proposal, could you assign it to me? I'm open to doing it.

Thanks in advance for feedback :)

@djwhitt
Copy link
Collaborator

djwhitt commented Sep 13, 2023

@rixcian Yeah, we'd be happy to get a PR for this. CCing @Bobinstein on this too since he helps out with our docs.

@rixcian
Copy link
Contributor Author

rixcian commented Sep 28, 2023

I think this PR can be closed now (#49 is already merged to the main branch).

@djwhitt
Copy link
Collaborator

djwhitt commented Sep 28, 2023

@rixcian Closing. Thanks for the reminder!

@djwhitt djwhitt closed this as completed Sep 28, 2023
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

2 participants