From a57e096dec0641bb43adce6e74c5d1331be151d2 Mon Sep 17 00:00:00 2001 From: Harshit chauhan Date: Fri, 14 Nov 2025 01:12:37 +0530 Subject: [PATCH] updated readme for local support --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index cfaec62..eba996b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ There is a [Network API](#network-api) which can be used to get latest set of mi ## Table of Contents - [Züs Overview](#züs-overview) - [Setup](#setup) +- [Local Development](#local-development) - [Buildding and starting the node](#building-and-starting-the-node) - [Point to another blockchain](#point-to-another-blockchain) - [Exposed APIs](#exposed-apis) @@ -36,6 +37,28 @@ Clone the repo and run the following command inside the cloned directory ./docker.local/bin/init.sh ``` +## Local Development + +When using 0dns for local development, you need to configure the `docker.local/config/0dns.yaml` file to disable HTTPS and path-based routing. This ensures that the miner and sharder URLs returned by the Network API work correctly in a local environment. + +Update `docker.local/config/0dns.yaml` and set: + +```yaml +use_https: false +use_path: false +``` + +These settings ensure that: +- URLs use `http://` instead of `https://` (appropriate for local development) +- URLs don't include path prefixes, making them compatible with local network configurations + +**Note:** After making these changes, restart the 0dns service for the changes to take effect: + +``` +./docker.local/bin/stop.sh +./docker.local/bin/start.sh +``` + ## Building and Starting the Node If there is new code, do a git pull and run the following command