diff --git a/src/about/contributing.md b/src/about/contributing.md index 340e2b5..15ec4f1 100644 --- a/src/about/contributing.md +++ b/src/about/contributing.md @@ -46,6 +46,13 @@ Visit also Erigon's **[Wiki](https://github.com/ledgerwatch/erigon/wiki)** to ga - Transaction Pool Design - Using Postman to test RPC. -# Contributing to Documentation +# Contributing to this Documentation -To contribute to the Erigon 3 book, commit your change to the development branch on **[Github](https://github.com/erigontech/docs/tree/development)**. You might want to run it locally to verify the output before committing, see how MdBook works [here](https://rust-lang.github.io/mdBook/index.html). +This documentation is powered by [MdBook](https://rust-lang.github.io/mdBook). + +To contribute to the Erigon 3 Docs, you can either: + +1) Create an Issue: Open a new issue in the main branch to suggest changes or report problems. +2) Open a Branch and Submit a PR: Create a new branch, make your changes, and submit a pull request (PR) on Github. + +Before committing your changes, it's recommended to run the documentation locally to verify the output. This ensures that your changes render correctly and maintain the consistency of the documentation. \ No newline at end of file diff --git a/src/getting-started/hw-requirements.md b/src/getting-started/hw-requirements.md index 346db49..29669a2 100644 --- a/src/getting-started/hw-requirements.md +++ b/src/getting-started/hw-requirements.md @@ -55,7 +55,7 @@ Archive nodes retain **all** historical state and require significantly more dis | Network | Disk Size (Required) | Disk Size (Recommended) | RAM (Required) | RAM (Recommended) | |-----------|----------------------|--------------------------|----------------|-------------------| | Mainnet | 2 TB | 4 TB | 32 GB | 64 GB | -| Polygon | 6 TB | 6 TB | 64 GB | 128 GB | +| Polygon | 4.3 TB | 6 TB | 64 GB | 128 GB | | Gnosis | 1 TB | 2 TB | 16 GB | 32 GB | diff --git a/src/getting-started/sw-requirements.md b/src/getting-started/sw-requirements.md index a14b937..1962924 100644 --- a/src/getting-started/sw-requirements.md +++ b/src/getting-started/sw-requirements.md @@ -22,13 +22,13 @@ Install **Build-essential** and **Cmake**: sudo apt install build-essential cmake -y ``` -### Go Programming Language (only for Linux and MacOS) +### Go Programming Language Erigon utilizes Go (also known as Golang) version 1.23 or newer for part of its development. It is recommended to have a fresh Go installation. If you have an older version, consider deleting the /usr/local/go folder (you may need to use sudo) and re-extract the new version in its place. To install the latest Go version, visit the official documentation at [https://golang.org/doc/install](https://golang.org/doc/install). -### C++ Compiler (only for Linux and MacOS) +### C++ Compiler This turns the C++ part of Erigon's code into a program your computer can run. You can use either **Clang** or **GCC**: diff --git a/src/installation/build_exec_win.md b/src/installation/build_exec_win.md index 9da7577..78ef971 100644 --- a/src/installation/build_exec_win.md +++ b/src/installation/build_exec_win.md @@ -58,7 +58,7 @@ Open the Command Prompt and type the following: git clone --branch release/3.0 --single-branch https://github.com/erigontech/erigon.git ``` -You might need to change the `ExecutionPolicy` to allow scripts created locally or signed by a trusted publisher to run: +You might need to change the `ExecutionPolicy` to allow scripts created locally or signed by a trusted publisher to run. Open a Powershell session as Administrator and type: ```powershell Set-ExecutionPolicy RemoteSigned diff --git a/src/installation/docker.md b/src/installation/docker.md index dfad2d4..8c3d0e2 100644 --- a/src/installation/docker.md +++ b/src/installation/docker.md @@ -43,7 +43,6 @@ If you want to start Erigon add the options according to the [basic usage](/basi ```bash docker run -it 36f25992dd1a --chain=holesky --prune.mode=minimal -docker run -it 36f25992dd1a --chain=holesky --prune.mode=minimal ``` To exit the container press `Ctrl+C`; the container will stop. diff --git a/src/installation/upgrading-md b/src/installation/upgrading-md deleted file mode 100644 index 7653ead..0000000 --- a/src/installation/upgrading-md +++ /dev/null @@ -1,89 +0,0 @@ -# Upgrading from a previous version - -To upgrade Erigon to a newer version when you've originally installed it via Git and manual compilation, you should follow these steps without needing to delete the entire folder: - -* **Terminate your Erigon** session by pressing CTRL+C - -* **Navigate to your Erigon directory** - -* **Fetch the latest changes from the repository**: You need to make sure your local repository is up-to-date with the main GitHub repository. Run: - - ```bash - git fetch --tags - ``` - -* **Check out** the [latest version](https://github.com/ledgerwatch/erigon/releases) and switch to it using: - - - ```bash - git checkout - ``` - - - Replace `` with the version tag of the new release, for example: - - ```bash - git checkout v3.0.0 - ``` - -* **Rebuild Erigon**: Since the codebase has changed, you need to compile the new version. Run: - - ```bash - make erigon - ``` - -This process updates your installation to the latest version you specify, while maintaining your existing data and configuration settings in the Erigon folder. You're essentially just replacing the executable with a newer version. - -# Docker -If you're using Docker to run Erigon, the process to upgrade to a newer version of the software is straightforward and revolves around pulling the latest Docker image and then running it. Here's how you can upgrade Erigon using Docker: - -* **Pull the Latest Docker Image**: First, find out the tag of the new release from the Erigon Docker Hub page. Once you know the tag, pull the new image: - - ```bash - docker pull erigontech/erigon: - ``` - - Replace `` with the actual version tag you wish to use. For example: - - ```bash - docker pull erigontech/erigon:v3.0.0-beta2 - ``` - - -* **List Your Docker Images**: Check your downloaded images to confirm the new image is there and get the new image ID: - - ```bash - docker images - ``` - - -* **Stop the Running Erigon Container**: If you have a currently running Erigon container, you'll need to stop it before you can start the new version. First, find the container ID by listing the running containers: - - ```bash - docker ps - ``` - - - Then stop the container using: - - ```bash - docker stop - ``` - - Replace `` with the actual ID of the container running Erigon. - -* **Remove the Old Container**: (Optional) If you want to clean up, you can remove the old container after stopping it: - - ```bash - docker rm - ``` - -* **Run the New Image**: Now you can start a new container with the new Erigon version using the new image ID: - - ```bash - docker run -it - ``` - -* **Verify Operation**: Ensure that Erigon starts correctly and connects to the desired network, verifying the logs for any initial errors. - -By following these steps, you'll keep your Docker setup clean and up-to-date with the latest Erigon version without needing to manually clean up or reconfigure your environment. Docker's ability to encapsulate software in containers simplifies upgrades and reduces conflicts with existing software on your machine. \ No newline at end of file diff --git a/src/installation/windows.md b/src/installation/windows.md index 75c07ea..b548765 100644 --- a/src/installation/windows.md +++ b/src/installation/windows.md @@ -3,8 +3,8 @@ There are 3 options for running Erigon 3 on Windows, listed from easiest to most difficult installation: -- [Build executable binaries natively for Windows](/installation/build_exec_win.md): Use the pre-built Windows executables that can be natively run on Windows without any emulation or containers required. - - [Use Docker](/installation/docker.md): Run Erigon in a Docker container for isolation from the host Windows system. This avoids dependencies on Windows but requires installing Docker. +- [Build executable binaries natively for Windows](/installation/build_exec_win.md): Use the pre-built Windows executables that can be natively run on Windows without any emulation or containers required. + - [Use Windows Subsystem for Linux (WSL)](/installation/wsl.md): Install the Windows Subsystem for Linux (WSL) to create a Linux environment within Windows. Erigon can then be installed in WSL by following the Linux installation instructions. This provides compatibility with Linux builds but involves more setup overhead. \ No newline at end of file diff --git a/src/op-node.md b/src/op-node.md deleted file mode 100644 index 08a6892..0000000 --- a/src/op-node.md +++ /dev/null @@ -1 +0,0 @@ -# Running an Op-node