diff --git a/SETUP.md b/SETUP.md index 10981c2..e3972fd 100644 --- a/SETUP.md +++ b/SETUP.md @@ -2,8 +2,8 @@ ## 1. Getting the executables and meeting prerequisites -First you need to download the correct release for your OS. You can find the latest releases [here](https://github.com/ConcealNetwork/conceal-guardian/releases) -Once the executables are donwloaded you simply extract them to directory of your choice. +First you need to download the correct release for your OS. You can find the latest releases [here](https://github.com/ConcealNetwork/conceal-guardian/releases). +Once the executables are donwloaded, you simply extract them to directory of your choice. If you are running o Windows you are fine, you don't need to do anything more in terms of prerequisites. But on linux you need to install "libboost". @@ -18,10 +18,10 @@ Then you are ready to go. ## 2. Options setup -You can run the Guardian in two ways. You can simply run the executable and it will start and lift up the node daemon and the monitor it. But this way if you restart your computer or kill the seesion, it will not automaticall start again. -In order to persist reboots you need to install it as a system service. Luckily the Guardian make this extremly easy for you. But first we need to configure it. The Guardian has build in interactive setup so its easy to do and you don't need to edit confi.json. +You can run the Guardian in two ways. You can simply run the executable and it will start and lift up the node daemon and the monitor it. But this way if you restart your computer, or kill the seesion, it will not automaticall start again. +In order to persist reboots you need to install it as a system service. Luckily the Guardian makes this extremly easy for you. But first we need to configure it. The Guardian has a build in interactive setup, so this is easy to do and you don't need to edit **config.json**. -Just run it with ```./guardian-linux64.exe --setup``` or on windows simply click in ```setup.bat```. Each OS has the executable of a different name so please use the appropriate on for your OS (I am using the linux one here). +Just run it with ```./guardian-linux64.exe --setup``` or on windows simply click on ```setup.bat```.Each OS has the executable of a different name so please use the appropriate one for your OS (I am using the linux one here). You will get something like this: ![Guardian setup](https://raw.githubusercontent.com/ConcealNetwork/conceal-guardian/master/setup/guardian_setup.jpg) @@ -34,7 +34,7 @@ The command to install the service is: ```./guardian-linux64.exe --service install``` -Once the service is installed you can simply run it with: +Once the service is installed, you can simply run it with: ```./guardian-linux64.exe --service start``` @@ -46,11 +46,11 @@ And to remove it just use: ```./guardian-linux64.exe --service remove``` -To see if the service is running correctly and what happening with it you can use the command: +To see if the service is running correctly and what is happening with it, you can use the command: ```./guardian-linux64.exe --service status``` -As I said its very easy and that is all you need to work with Guardian as a system service. The commands are the same for Windows and Linux OS. Take note that on Windows and Linux you need **administrative** rights for working with service commands. +As I said its very easy and that is all you need in order to work with the Guardian as a system service. The commands are the same for Windows and Linux OS. Take note that on Windows and Linux you need **administrative** rights for working with service commands. ## 4. Updating to the latest node daemon version @@ -63,11 +63,11 @@ If you have a type 1 of installation you can use the build in updater for the da ```./guardian-linux64.exe --node update``` -The Guardian will download and update the latest stable daemon (conceald). +The Guardian will download and update the latest stable daemon (conceald). Or if you have a fresh install and don't have the daemon yet, the Guardian will download it and install it on the first run automatically. ## 5. Updating to the latest guardian version -The updating of the guardian itself is similar and easy as updating the node daemon. Simply type +The updating of the guardian itself is similar and as easy as updating the node daemon. Simply type ```sudo ./guardian-linux64.exe --update```