From 423b41b8df68b36533f5e6eda04d7c7ee063fe2e Mon Sep 17 00:00:00 2001 From: Niko PLP Date: Fri, 22 Mar 2024 19:55:30 +0200 Subject: [PATCH] instruction for localhost ngd --- ngd/README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/ngd/README.md b/ngd/README.md index c4692e7..a087dee 100644 --- a/ngd/README.md +++ b/ngd/README.md @@ -6,14 +6,26 @@ See [Build release binaries](../README.md#build-release-binaries) in the main pa ## Usage -### Create the first admin user +### For a localhost server: The first start will create an invitation for the admin, so you can create your wallet + +``` +ngd --save-key -l 1440 --invite-admin +``` + +this will give you a link that you should open in your web browser. If there are many links, choose the one that starts with `http://localhost:`. + +The computer you use to open the link should have direct access to the ngd server on localhost. In most of the cases, it will work, as you are running ngd on localhost. If you are running ngd in a docker container, then you need to give access to the container to the local network of the host by using `docker run --network="host"`. https://docs.docker.com/network/drivers/host/ + +Follow the steps on the screen to create your wallet :) + +### For a server behind a domain: create the first admin user The current directory will be used to save all the config, keys and storage data. If you prefer to change the base directory, use the argument `--base [PATH]` when using `ngd` and/or `ngcli`. ``` ngcli gen-key -ngd -v --save-key -l 1440 --admin +ngd -v --save-key -l 1440 -d --admin // note the server peerID from the logs ``` @@ -37,17 +49,5 @@ you can now save the configs of both the server and client ``` ngd -l 1440 --save-config -ngcli -s 127.0.0.1,1440, -u --save-config +ngcli -s 127.0.0.1,1440, -d -u --save-config ``` - -### Create an invitation for yourself so you can create your wallet - -``` -ngcli admin add-invitation -``` - -this will give you a link that you should open in your web browser. If there are many links, choose the one that starts with `http://localhost:`. - -The computer you use to open the link should have direct access to the ngd server on localhost. In most of the cases, it will work, as you are running ngd on localhost. If you are running ngd in a docker container, then you need to give access to the container to the local network of the host by using `docker run --network="host"`. https://docs.docker.com/network/drivers/host/ - -Follow the steps on the screen :)