From 1ace8ed2e94139ef3a7f0c44473b500e874cf7eb Mon Sep 17 00:00:00 2001 From: RadoslavDimchev Date: Sat, 28 Oct 2023 13:36:44 +0300 Subject: [PATCH] fix: details for Erigon windows doc --- .../ValidatorSetup/ValidatorInstalling/documentations.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts b/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts index 1839f058..5feef6cb 100644 --- a/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts +++ b/src/pages/ValidatorOnboarding/ValidatorSetup/ValidatorInstalling/documentations.ts @@ -54,7 +54,7 @@ export const DOCUMENTATIONS: Documentation = { [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](https://github.com/ledgerwatch/erigon/releases) for release notes.', [WINDOWS]: - '### Windows\n**How to install Erigon in Windows**\n\nWindows users can run Erigon in 3 possible ways:\n- [Build executable binaries natively for Windows](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#build-executable-binaries-natively-for-windows)\n- [Use Docker](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#use-docker)\n- [Use Windows Subsystem for Linux. (WSL)](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#use-windows-subsystem-for-linux-wsl)\n\n## Build executable binaries natively for Windows\nBefore proceeding, ensure that the general [requirements](https://erigon.gitbook.io/erigon/basic-usage/getting-started#prerequisites) are met.\n\n**Installing Chocolatey**\n\nInstall Chocolatey package manager by following [these instructions](https://docs.chocolatey.org/en-us/choco/setup).\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```\nchoco -v\n```\nNow you need to install the following components: cmake, make, mingw by:\n```\nchoco install cmake make mingw\n```\nImportant 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\\bin\\mdbx\\CMakeFiles 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:\n```\nC:\\ProgramData\\chocolatey\\lib\\mingw\\tools\\install\\mingw64\\bin\n```\n\n**Clone the Erigon repository**\n\nOpen the Command Prompt and type the following:\n```\ngit clone --branch v2.49.2 --single-branch https://github.com/ledgerwatch/erigon.git\n```\n\n**Compiling Erigon**\n\nTo compile Erigon there are two alternative methods:\n- [Compiling from the wmake.ps1 file in the File Explorer](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#compiling-from-the-wmake.ps1-file-in-the-file-explorer)\n- [Using the PowerShell CLI](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#using-the-powershell-cli)\n\n**Compiling from the wmake.ps1 file in the File Explorer**\n\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.\n\n**Using the PowerShell CLI**\n\nIn the search bar on your computer, search for “Windows PowerShell” and open it.\nChange the working directory to "erigon"\n```\ncd erigon\n```\nBefore proceeding make sure that the [Set-Execution Policy](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.3) PowerShell execution running policies are correct for your Windows account.\nNow you can compile Erigon and/or any of its component:\n```\n.\\wmake.ps1 [-target] \n```\nFor example, to build the Erigon executable write:\n```\n.\\wmake.ps1 erigon\n```\nAll binaries are placed in the .\\build\\bin\\ subfolder.\n\n### Use Docker\nSee [docker-compose.yml](https://github.com/ledgerwatch/erigon/blob/devel/docker-compose.yml).\n\n### Use Windows Subsystem for Linux (WSL)\nWSL enables running a complete GNU/Linux environment natively within Windows 10, providing Linux compatibility without the performance overhead of traditional virtualization.\nTo install WSL, follow the instructions [here](https://learn.microsoft.com/en-us/windows/wsl/install).\nInformation: WSL Version 2 is the only version supported.\nUnder this option you can build Erigon as you would on a regular Linux distribution see detailed instructions [here](https://erigon.gitbook.io/erigon/basic-usage/getting-started/linux-and-macos).\nYou can also point your data to any of the mounted Windows partitions ( e.g. /mnt/c/[...], /mnt/d/[...] etc..) but be aware that performance will be affected: this is due to the fact that these mount points use DrvFS, which is a network file system, and additionally MDBX locks the db for exclusive access, meaning that only one process at a time can access the data.\nWarning: the remote db RPCdaemon is an experimental feature and is not recommended, it is extremely slow. It is highly preferable to use the embedded RPCdaemon.\nThis has implications for running rpcdaemon, which must be configured as a remote DB, even if it is running on the same machine. If your data is hosted on the native Linux filesystem instead, there are no restrictions. Also note that the default WSL2 environment has its own IP address, which does not match the network interface of the Windows host: take this into account when configuring NAT on port 30303 on your router.', + '### Windows\n**How to install Erigon in Windows**\n\nWindows users can run Erigon in 3 possible ways:\n- [Build executable binaries natively for Windows](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#build-executable-binaries-natively-for-windows)\n- [Use Docker](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#use-docker)\n- [Use Windows Subsystem for Linux. (WSL)](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#use-windows-subsystem-for-linux-wsl)\n\n## Build executable binaries natively for Windows\nBefore proceeding, ensure that the general [requirements](https://erigon.gitbook.io/erigon/basic-usage/getting-started#prerequisites) are met.\n\n**Installing Chocolatey**\n\nInstall Chocolatey package manager by following [these instructions](https://docs.chocolatey.org/en-us/choco/setup).\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```\nchoco -v\n```\nNow you need to install the following components: `cmake`, `make`, `mingw` by:\n```\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 the `build\\bin\\mdbx\\CMakeFiles` subfolder of the cloned repo, or you can run Erigon using the other two options below.\n\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**”.\n\nClick the “**Environment Variables...**” button.\n\nLook down at the "**System variables**" box and double click on "**Path**" to add a new path.\n\nThen click on the "**New**" button and paste the path here:\n```\nC:\\ProgramData\\chocolatey\\lib\\mingw\\tools\\install\\mingw64\\bin\n```\n\n**Clone the Erigon repository**\n\nOpen the Command Prompt and type the following:\n```\ngit clone --branch v2.49.2 --single-branch https://github.com/ledgerwatch/erigon.git\n```\n\n**Compiling Erigon**\n\nTo compile Erigon there are two alternative methods:\n- [Compiling from the wmake.ps1 file in the File Explorer](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#compiling-from-the-wmake.ps1-file-in-the-file-explorer)\n- [Using the PowerShell CLI](https://erigon.gitbook.io/erigon/basic-usage/getting-started/windows#using-the-powershell-cli)\n\n**Compiling from the wmake.ps1 file in the File Explorer**\n\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**"\n\nPowerShell will compile Erigon and all of its modules. All binaries are placed in the .\\build\\bin\\ subfolder.\n\n**Using the PowerShell CLI**\n\nIn the search bar on your computer, search for “**Windows PowerShell**” and open it.\n\nChange the working directory to "**erigon**"\n```\ncd erigon\n```\nBefore proceeding make sure that the [Set-Execution Policy](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.3) PowerShell execution running policies are correct for your Windows account.\n\nNow you can compile Erigon and/or any of its component:\n```\n.\\wmake.ps1 [-target] \n```\nFor example, to build the Erigon executable write:\n```\n.\\wmake.ps1 erigon\n```\nAll binaries are placed in the `.\\build\\bin\\` subfolder.\n\n### Use Docker\nSee [docker-compose.yml](https://github.com/ledgerwatch/erigon/blob/devel/docker-compose.yml).\n\n### Use Windows Subsystem for Linux (WSL)\nWSL enables running a complete GNU/Linux environment natively within Windows 10, providing Linux compatibility without the performance overhead of traditional virtualization.\n\nTo install WSL, follow the instructions [here](https://learn.microsoft.com/en-us/windows/wsl/install).\n\n**Information:** WSL Version 2 is the only version supported.\n\nUnder this option you can build Erigon as you would on a regular Linux distribution (see detailed instructions [here](https://erigon.gitbook.io/erigon/basic-usage/getting-started/linux-and-macos)).\n\nYou can also point your data to any of the mounted Windows partitions ( e.g. `/mnt/c/[...], /mnt/d/[...]` etc..) but be aware that performance will be affected: this is due to the fact that these mount points use `DrvFS`, which is a network file system, and additionally MDBX locks the db for exclusive access, meaning that only one process at a time can access the data.\n\n**Warning**: the remote db RPCdaemon is an experimental feature and is not recommended, it is extremely slow. It is highly preferable to use the embedded RPCdaemon.\n\nThis has implications for running `rpcdaemon`, which must be configured as a remote DB, even if it is running on the same machine. If your data is hosted on the native Linux filesystem instead, there are no restrictions. Also note that the default WSL2 environment has its own IP address, which does not match the network interface of the Windows host: take this into account when configuring NAT on port 30303 on your router.', [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](https://github.com/ledgerwatch/erigon/releases) for release notes.', },