From 462cf75201ed665d0deac7464b8fb883e5df7dd0 Mon Sep 17 00:00:00 2001 From: RadoslavDimchev Date: Thu, 26 Oct 2023 09:48:38 +0300 Subject: [PATCH] feat: add docs for Erigon --- .../ValidatorSetup/ValidatorInstalling/documentations.ts | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts b/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts index e85d256a..e83af2fd 100644 --- a/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts +++ b/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts @@ -49,9 +49,12 @@ export const DOCUMENTATIONS: Documentation = { general: "In order to use Erigon, the software has to be installed first. There are several ways to install Erigon, depending on the operating system and the user's choice of installation method, e.g. using a package manager, container or building from source.", documentation: { - [MAC]: 'Text for mac', - [WINDOWS]: 'Text for windows', - [LINUX]: 'Text for linux', + [MAC]: + '### Linux and MacOS\n\nHow to install Erigon in Linux and MacOS\n\nThe basic Erigon configuration is suitable for most users just wanting to run a node. For building the latest stable release use the following command:\n\n```bash\ngit clone --branch v2.52.5 --single-branch https://github.com/ledgerwatch/erigon.git\ncd erigon\nmake erigon\n```\n\nYou can check the list of releases for release notes.', + [WINDOWS]: + '### Build executable binaries natively for Windows\nBefore proceeding, ensure that the general requirements are met.\n**Installing Chocolatey**\nInstall Chocolatey package manager by following these instructions.\nOnce your Windows machine has the above installed, open the Command Prompt by typing "cmd" in the search bar and check that you have correctly installed Chocolatey:\n```bash\nchoco -v\n```\nNow you need to install the following components: cmake, make, mingw by:\n```bash\nchoco install cmake make mingw\n```\n**Important note about Anti-Virus:** During the compiler detection phase of MinGW, some temporary executable files are generated to test the compiler capabilities. It\'s been reported that some anti-virus programs detect these files as possibly infected with the Win64/Kryptic.CIS Trojan horse (or a variant of it). Although these are false positives, we have no control over the 100+ vendors of security products for Windows and their respective detection algorithms and we understand that this may make your experience with Windows builds uncomfortable. To work around this, you can either set exclusions for your antivirus software specifically for thebuild\binmdbxCMakeFiles subfolder of the cloned repo, or you can run Erigon using the other two options below.\nMake sure that the Windows System Path variable is set correctly. Use the search bar on your computer to search for “Edit the system environment variable”.\nClick the “Environment Variables...” button. \nLook down at the "System variables" box and double click on "Path" to add a new path.\nThen click on the "New" button and paste the path here: C:ProgramDatachocolateylibmingw\toolsinstallmingw64\bin\n**Clone the Erigon repository**\nOpen the Command Prompt and type the following:\n```bash\ngit clone --branch v2.49.2 --single-branch https://github.com/ledgerwatch/erigon.git \n```\n**Compiling Erigon**\nTo compile Erigon there are two alternative methods:\n1. **Compiling from the wmake.ps1 file in the File Explorer**\nThis is the fastest way which normally works for everyone. Open the File Explorer and go to the Erigon folder, then right click the wmake file and choose "Run with PowerShell"\nPowerShell will compile Erigon and all of its modules. All binaries are placed in the .\build\bin subfolder. \n2. **Using the PowerShell CLI**\nIn the search bar on your computer, search for “Windows PowerShell” and open it.\nChange the working directory to "erigon":\n```bash\ncd erigon\n```\nBefore proceeding make sure that the Set-Execution Policy PowerShell execution running policies are correct for your Windows account.\nNow you can compile Erigon and/or any of its component:\n```bash\n.wmake.ps1 [-target] \n```\nFor example, to build the Erigon executable write: \n```bash\n.wmake.ps1 erigon\n```\nAll binaries are placed in the .\build\bin subfolder.', + [LINUX]: + '### Linux and MacOS\n\nHow to install Erigon in Linux and MacOS\n\nThe basic Erigon configuration is suitable for most users just wanting to run a node. For building the latest stable release use the following command:\n\n```bash\ngit clone --branch v2.52.5 --single-branch https://github.com/ledgerwatch/erigon.git\ncd erigon\nmake erigon\n```\n\nYou can check the list of releases for release notes.', }, }, Nimbus: {