Skip to content

Update run a local chain#1469

Open
dragosgd wants to merge 2 commits intomainfrom
updateRunALocalChain
Open

Update run a local chain#1469
dragosgd wants to merge 2 commits intomainfrom
updateRunALocalChain

Conversation

@dragosgd
Copy link
Contributor

Purpose

Replace the outdated "Run a local chain" article with a restructured version that reflects the two available approaches: Docker images via concordium-local-stack (recommended) and building from source (advanced).

Changes

  • Added index.rst intro article explaining use cases and linking to both approaches
  • Added run-local-chain-docker.rst pointing to the concordium-local-stack repo (single source of truth)
  • Added run-local-chain-source.rst with the advanced source-build guide
  • Removed old article

Checklist

  • My code follows the style of this project.
  • The code compiles without warnings.
  • I have performed a self-review of the changes.
  • I have documented my code, in particular the intent of the
    hard-to-understand areas.
  • (If necessary) I have updated the CHANGELOG.

CLA acceptance

By submitting the contribution I accept the terms and conditions of the
Contributor License Agreement v1.0

@dragosgd dragosgd self-assigned this Jan 14, 2026
@dragosgd dragosgd added the preview Trigger a documentation preview for a PR. label Feb 6, 2026
@github-actions
Copy link

github-actions bot commented Feb 6, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://developer.concordium.software/pr-preview/pr-1469/

Built to branch gh-pages at 2026-02-06 09:16 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

- **PostgreSQL Database** supporting wallet proxy and CCDScan
- **pgAdmin** on port 8432 for database management
- **Web Server** on port 7020 for PLT token metadata
- **ZK Verifier Backend** on port 7017
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these all mandatory? What if someone with limited storage wants to install only node and bare minimum infra?

.. code-block:: console

cd concordium-misc-tools/genesis-creator
cargo run -- generate --config ./examples/genesis9.toml
Copy link
Collaborator

@bogacyigitbasi bogacyigitbasi Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if I have installed the genesis creator? I have it in my system cause run local chain with Docker image guide asked me to. now I have it but cant use it to generate. The feeling is like I have to clone the code and proceed, if thats the case why we have it executable. I feel like we just need this generate command with a toml file. and you are already sharing it above. Can we update this section with something like either clone repo and get the toml file from there or create one and feed the generate with that configuration? somthing copy and paste? or maybe we can just mention, executable genesis-creator is not enough on its own

Copy link
Collaborator

@bogacyigitbasi bogacyigitbasi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall document is well constructed. In general its looking good but I find it difficult to navigate between different pages. Also the page showing the node build was also not reflecting how to install dependencies, if we want people to follow the instructions here one by one, we may either internalize that section or at least add how to install those dependencies for each OS type (might be an overkill - TBD later)

.. code-block:: console

cd concordium-misc-tools/genesis-creator
cargo run -- generate --config ./examples/genesis9.toml
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It requires concordium-rust-sdk as a dependency, we mention that user should install and manage the rust dependencies from here but that page doesnt explicitly mention the rust-sdk.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe clone it with --recurse-submodules


.. code-block:: console

stack build
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps cd in the node first?

Step 4: Build and run the node
==============================

Here we describe how to build and run the `node <https://github.com/Concordium/concordium-node/tree/main/concordium-node#building-the-node>`_ and setting up a local network.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I followed the new page for node build and run. just wanted to raise this discussion point, I dont feel like asking people to visit many different pages to complete a process we explain here. it is several times back and forth. Cant we embed some from there to here in this section?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also another problem is, we ask people to install the dependencies but dont tell how? This is really demanding too much energy.

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

preview Trigger a documentation preview for a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants