open-horizon / open-horizon/devops
Documentation: Note that environment variables for the configuration templates should always be set when using the all-in-one script
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 12
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Description
Related: #179
It should be highlighted in the user documentation for the all-in-one installer that the user must set certain environment variables when using the all-in-one script (e.g. AGBOT_TOKEN) or the deployment will break. It is also relevant to note that any other custom settings used in the configuration templates (e.g. internal port addresses, container specific settings like AGBOT_AGREEMENT_BATCH_SIZE) will not persist if they are not set.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the user documentation for the all-in-one installer, then inspect the all-in-one script and its configuration templates. Document that required variables such as AGBOT_TOKEN must be set, and explain that custom template settings do not persist unless their corresponding environment variables are set.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100