From f1e572870543576c8a0cac8b04077c317ad8a82f Mon Sep 17 00:00:00 2001 From: Rosco Kalis Date: Thu, 6 Jan 2022 15:47:45 +0100 Subject: [PATCH] Small updates to the dashboard docs --- .../getting-started/using-the-truffle-dashboard.md | 9 +++------ src/docs/truffle/reference/truffle-commands.md | 2 +- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/src/docs/truffle/getting-started/using-the-truffle-dashboard.md b/src/docs/truffle/getting-started/using-the-truffle-dashboard.md index d33588f1c..f03d01a6a 100644 --- a/src/docs/truffle/getting-started/using-the-truffle-dashboard.md +++ b/src/docs/truffle/getting-started/using-the-truffle-dashboard.md @@ -16,9 +16,7 @@ To start a Truffle Dashboard, you need to run the `truffle dashboard` command in > truffle dashboard [--port ] [--host ] [--verbose] Truffle Dashboard running at http://localhost:24012 - http://192.168.178.21:24012 DashboardProvider RPC endpoint running at http://localhost:24012/rpc - http://192.168.178.21:24012/rpc ``` By default, this starts a dashboard at `http://localhost:24012` and opens the dashboard in a new tab in your default browser. The Dashboard then prompts you to connect your wallet and confirm that you're connected to the right network. You should double check your connected network at this point, since switching to a different network during a deployment can have unintended consequences. @@ -37,7 +35,6 @@ module.exports = { port: 24012, } - // Not to be networks: { // ... network configurations, including the network named 'dashboard' } @@ -47,7 +44,7 @@ module.exports = { ## Connecting to the dashboard -To make connecting to the Truffle Dashboard easy, Truffle includes a builtin network named "dashboard". This builtin network automatically uses the port and host specified in the dashboard config or falls back to the default `localhost:24012`. This builtin network can be used with all your deployments or scripts. +To make connecting to the Truffle Dashboard easy, Truffle includes a builtin network named "dashboard". This builtin network automatically uses the port and host specified in the dashboard config or falls back to the default `http://localhost:24012`. This builtin network can be used with all your deployments or scripts. ``` truffle migrate --network dashboard @@ -92,7 +89,7 @@ module.exports = { networks: { // ... rest of network config - dashboard: { + 'truffle-dashboard': { url: "http://localhost:24012/rpc" } }, @@ -102,6 +99,6 @@ module.exports = { From there it can be used with any Hardhat tasks as well as tools like hardhat-deploy. ``` -hardhat deploy --network dashboard +hardhat deploy --network truffle-dashboard ``` diff --git a/src/docs/truffle/reference/truffle-commands.md b/src/docs/truffle/reference/truffle-commands.md index 6122d5f1d..ac2678ce3 100644 --- a/src/docs/truffle/reference/truffle-commands.md +++ b/src/docs/truffle/reference/truffle-commands.md @@ -115,7 +115,7 @@ truffle dashboard [--port ] [--host ] [--verbose] Options: * `--port `: Port to start the Truffle dashboard on (default `24012`). -* `--host `: Host to start the Truffle dashboard on (default `0.0.0.0`). +* `--host `: Host to start the Truffle dashboard on (default `localhost`). * `--verbose`: Start the Truffle dashboard with additional verbose logging (default `false`) It is also possible to specify these options in the `truffle-config.js` file under `"dashboard"`. For example: