smartcontractkit / smartcontractkit/documentation
[Enhancement]: <What needs to be fixed in the Running a Chainlink Node documentation and what could be improved in the docker setup >
@yacine-benichou is already working on this.
Since May 18, 2023.
- Dominant language
- MDX
- Stars
- 526
- Forks
- 478
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 75
Description
What would you like us to improve?
-
If you go to this link(https://docs.chain.link/chainlink-nodes/v1/running-a-chainlink-node#using-docker) and look at the MORE tab on the right side of the screen, you will see that there is no Edit this page link. This needs to be fixed.
-
when I look at tab 4 in the Run Chainlink node and click on Sepolia on Nodes <= 1.13.1, it says goerli.
It looks like we need to modify the command.
cd ~/.chainlink-goerli && docker run --platform linux/x86_64/v8 --name chainlink -v ~/.chainlink-goerli:/chainlink -it -p 6688:6688 --add-host=host.docker.internal:host-gateway smartcontract/chainlink:1.13.1 -config /chainlink/config.toml -secrets /chainlink/secrets.toml node start
- I found the commands provided in the documentation to be too long. It would be nice if you could upgrade the documentation by creating a docker-compose.yml like the following.
This is because docker-compose is better at managing chainlink nodes than postgres.
services:
pg_chainlink:
image: "postgres"
ports:
- "5432:5432"
env_file:
- database.env
volumes:
- /$CHAINLINK_NODE_PATH/data:/var/lib/postgresql/data/
chainlink:
image: "smartcontract/chainlink:1.3.0"
env_file:
- .env
depends_on:
- pg_chainlink
ports:
- "6688:6688"
volumes:
- /$CHAINLINK_NODE_PATH/chainlink-volume:/chainlink/
command: node start --password /chainlink/password.txt --api /chainlink/apicredentials.txt
How important it is?
- errors that do not appear on the screen when the "Edit this page" button is clicked in the documentation affect documentation reliability.
- If there are typos in the command examples, it affects the reliability of the documentation.
- a more convenient management method for docker should be presented to make it easier for developers to use.
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.
Assessment
This issue has not been assessed yet.