mirror of
https://github.com/farcasterxyz/hub-monorepo.git
synced 2026-01-10 05:38:07 -05:00
docs: Update disk space requirements (#2353)
## Why is this change needed? These were out of date as the network has grown. ## Merge Checklist - [x] PR title adheres to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard - [ ] PR has a [changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets) - [x] PR has been tagged with a change label(s) (i.e. documentation, feature, bugfix, or chore) - [x] PR includes [documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs) if necessary. <!-- start pr-codex --> --- ## PR-Codex overview This PR focuses on updating the documentation for the `Hubble` application, specifically regarding hardware requirements and setup instructions, including increases in RAM and disk space requirements. ### Detailed summary - Updated RAM requirement from `8GB` to `16GB` for the `Mainnet Hub`. - Increased disk space requirement from `20GB` to `300GB` for the `Mainnet Hub`. - Adjusted disk size in `main.tf` from `200GB` to `300GB`. - Updated storage requirement from `200GB` to `300GB` in installation instructions. - Changed exposed ports from `2282 - 2285` to `2282 & 2283` in installation instructions. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
This commit is contained in:
@@ -1,15 +1,15 @@
|
||||
# Installation
|
||||
|
||||
We recommend running Hubble on an always-on server that has [Docker](https://docs.docker.com/desktop/install/linux-install/) installed.
|
||||
We recommend running Hubble on an always-on server that has [Docker](https://docs.docker.com/desktop/install/linux-install/) installed.
|
||||
|
||||
## Requirements
|
||||
|
||||
Hubble can be installed in 30 minutes, and a full sync can take 1-2 hours to complete. You'll need a machine that has:
|
||||
Hubble can be installed in 30 minutes, and a full sync can take 1-2 hours to complete. You'll need a machine that has:
|
||||
|
||||
- 16 GB of RAM
|
||||
- 4 CPU cores or vCPUs
|
||||
- 200 GB of free storage
|
||||
- A public IP address with ports 2282 - 2285 exposed
|
||||
- 300 GB of free storage
|
||||
- A public IP address with ports 2282 & 2283 exposed (port 2281 is optional)
|
||||
|
||||
See [tutorials](./tutorials.html) for instructions on how to set up cloud providers to run Hubble.
|
||||
|
||||
@@ -18,7 +18,7 @@ You will need RPC endpoints for Ethereum nodes on L2 OP Mainnet, L1 Mainnet and
|
||||
|
||||
## Install via Script
|
||||
|
||||
The install script is the simplest way to set up Hubble.
|
||||
The install script is the simplest way to set up Hubble.
|
||||
|
||||
```bash
|
||||
curl -sSL https://download.thehubble.xyz/bootstrap.sh | bash
|
||||
@@ -72,9 +72,9 @@ HUB_OPERATOR_FID=your-fid
|
||||
|
||||
```bash
|
||||
docker compose up hubble -d
|
||||
```
|
||||
```
|
||||
|
||||
Docker compose will start a Hubble container that exposes ports for networking and writes data to `.hub` and `.rocks` directories. Hubble will now sync with the contracts and other hubble instances to download all messages on the network.
|
||||
Docker compose will start a Hubble container that exposes ports for networking and writes data to `.hub` and `.rocks` directories. Hubble will now sync with the contracts and other hubble instances to download all messages on the network.
|
||||
|
||||
7. To view the status of the sync and hubble, follow the logs
|
||||
|
||||
@@ -86,7 +86,7 @@ docker compose logs -f hubble
|
||||
|
||||
### Upgrading Hubble
|
||||
|
||||
Navigate to `apps/hubble` in hub-monorepo and run:
|
||||
Navigate to `apps/hubble` in hub-monorepo and run:
|
||||
|
||||
```bash
|
||||
git fetch --tags --force && git checkout @latest # Checkout to the latest release
|
||||
@@ -95,7 +95,7 @@ docker compose stop && docker compose up -d --force-recreate --pull always # St
|
||||
|
||||
## Installing from source
|
||||
|
||||
Hubble can also be built and run directly from source without Docker.
|
||||
Hubble can also be built and run directly from source without Docker.
|
||||
|
||||
#### Installing Dependencies
|
||||
|
||||
@@ -112,7 +112,7 @@ First, ensure that the following are installed globally on your machine:
|
||||
- `cd hub-monorepo` to enter the directory
|
||||
- `yarn install` to install dependencies
|
||||
- `yarn build` to build Hubble and its dependencies
|
||||
- `yarn test` to ensure that the test suite runs correctly. If integration tests fail, run `docker compose up redis postgres` and retry.
|
||||
- `yarn test` to ensure that the test suite runs correctly. If integration tests fail, run `docker compose up redis postgres` and retry.
|
||||
|
||||
#### Running Hubble
|
||||
To run the Hubble commands, go to the Hubble app (`cd apps/hubble`) and run the `yarn` commands.
|
||||
@@ -127,7 +127,7 @@ To upgrade hubble, find the latest [release tag](https://github.com/farcasterxyz
|
||||
|
||||
```bash
|
||||
git fetch --tags # to fetch the latest tags
|
||||
git checkout @farcaster/hubble@latest # Or use a specific version.
|
||||
git checkout @farcaster/hubble@latest # Or use a specific version.
|
||||
yarn install && yarn build # in the root folder
|
||||
```
|
||||
|
||||
@@ -151,7 +151,7 @@ docker compose exec hubble /bin/sh
|
||||
|
||||
- If upgrading from 1.3.3 or below, please set `ETH_MAINNET_RPC_URL=your-ETH-mainnet-RPC-URL` (if using docker) or provide the `--eth-mainnet-rpc-url` flag (if not using docker)
|
||||
|
||||
- If you're changing your Hub from one network to another, you'll need to delete your database contents:
|
||||
- If you're changing your Hub from one network to another, you'll need to delete your database contents:
|
||||
|
||||
```bash
|
||||
docker compose stop && docker compose run --rm hubble yarn dbreset
|
||||
|
||||
@@ -15,7 +15,7 @@ BOOTSTRAP_NODE=/dns/testnet1.farcaster.xyz/tcp/2282
|
||||
```
|
||||
## Mainnet
|
||||
|
||||
A Mainnet Hub connects to the production environment used by all apps on the network. You will need 8GB RAM and 20 GB of disk space to operate a mainnet hub.
|
||||
A Mainnet Hub connects to the production environment used by all apps on the network. You will need 16GB RAM and 300 GB of disk space to operate a mainnet hub.
|
||||
|
||||
Update the `.env` file in your `apps/hubble` directory with the network ID and bootstrap nodes.
|
||||
```sh
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Run a Hubble on GCP
|
||||
|
||||
## Intro
|
||||
This is a step-by-step guide to setting up Hubble on GCP.
|
||||
This is a step-by-step guide to setting up Hubble on GCP.
|
||||
It usually takes less than 30 minutes to complete the whole process.
|
||||
|
||||
### Requirements
|
||||
@@ -26,7 +26,7 @@ Execute the below commands in the cloud shell:
|
||||
nano main.tf
|
||||
</code></pre>
|
||||
|
||||
Now paste the content of below into your main.tf \
|
||||
Now paste the content of below into your main.tf \
|
||||
Replace "$YOUR_PROJECT_ID" with your personal ID.
|
||||
|
||||
<figure><img src="../assets/images/gcp_project_id.png" /></figure>
|
||||
@@ -48,7 +48,7 @@ resource "google_compute_instance" "farcaster-hub-vm" {
|
||||
boot_disk {
|
||||
initialize_params {
|
||||
image = "ubuntu-2004-focal-v20231213" # Ubuntu 20.04 LTS image URL
|
||||
size = 200 # 200 GB disk size
|
||||
size = 300 # 300 GB disk size
|
||||
}
|
||||
}
|
||||
|
||||
@@ -69,7 +69,7 @@ resource "google_compute_instance" "farcaster-hub-vm" {
|
||||
resource "google_compute_firewall" "farcaster-p2p-ports" {
|
||||
name = "farcaster-p2p-ports"
|
||||
network = "default"
|
||||
|
||||
|
||||
# allow incoming traffic for ports 2282-2285
|
||||
allow {
|
||||
protocol = "tcp"
|
||||
|
||||
Reference in New Issue
Block a user