ar-io/ar-io-node

docs: specify and describe all envs in docs

Closed this issue · 3 comments

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 :)

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

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

@rixcian Closing. Thanks for the reminder!