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

[Enhancement]: <What needs to be fixed in the Running a Chainlink Node documentation and what could be improved in the docker setup > #1285

Open
0x-Robert opened this issue May 9, 2023 · 1 comment
Assignees
Labels
enhancement Enhance existing content or processes triage

Comments

@0x-Robert
Copy link

0x-Robert commented May 9, 2023

What would you like us to improve?

  1. 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.

  2. 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

  1. 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?

  1. errors that do not appear on the screen when the "Edit this page" button is clicked in the documentation affect documentation reliability.
  2. If there are typos in the command examples, it affects the reliability of the documentation.
  3. a more convenient management method for docker should be presented to make it easier for developers to use.
@0x-Robert 0x-Robert added enhancement Enhance existing content or processes triage labels May 9, 2023
@yacine-benichou
Copy link
Contributor

Issue #1 appears to be fixed and issue #2 is fixed in PR #1308.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhance existing content or processes triage
Projects
None yet
Development

No branches or pull requests

2 participants