Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): corrected errors in installation instructions #2087

Merged
merged 1 commit into from
Jul 3, 2024

Conversation

vsu727
Copy link
Contributor

@vsu727 vsu727 commented Jun 23, 2024

Fixes issue #2086

Motivation

Due to errors or outdated information in the Farcaster Hub installation guides, the Hub cannot be synchronized due to lack of memory which will prevent it from starting and working correctly. This error is very important because it creates difficulties for new users at the very initial stage of work and familiarization with Farcaster Hub

Change Summary

Changes have been made regarding the minimum amount of memory required for Farcaster Hub to work correctly. The old value is 60 GB in the GCP installation guide and 140 GB is the old value in the main installation guide. Farcaster Hub currently takes up about 150 GB. The old memory values have been changed to 160 GB, which allows you to run the Hub and have a reserve of correct operation for a period of time

Merge Checklist

Choose all relevant options below by adding an x now or at any time before submitting for review

Additional Context

According to the GCP guide we create a virtual server and set the server parameters via Google Cloud Console by copying the data from the guide into the created file "main.tf"
1 screenshot

The virtual server has been configured with these memory settings
2 screenshot

Then after running the script specified in the main installation guide on the created server Hub starts synchronization, but after a while it stops with the error "code 2".
3 screenshot

This error means that Hub cannot continue synchronization due to lack of memory
4 screenshot

Warpcast: @vsu


PR-Codex overview

This PR increases the disk size for the Ubuntu 20.04 LTS image in the GCP tutorial and adjusts the storage requirement to 160 GB in the installation guide.

Detailed summary

  • Increased disk size for Ubuntu 20.04 LTS image to 160 GB in GCP tutorial
  • Adjusted storage requirement to 160 GB in the installation guide

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

changeset-bot bot commented Jun 23, 2024

⚠️ No Changeset found

Latest commit: d4fa32e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jun 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hub-monorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 23, 2024 7:42pm

Copy link

codecov bot commented Jul 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.48%. Comparing base (1880070) to head (d4fa32e).
Report is 218 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2087       +/-   ##
===========================================
- Coverage   74.05%   45.48%   -28.58%     
===========================================
  Files          99      140       +41     
  Lines        9425    22508    +13083     
  Branches     2097     7828     +5731     
===========================================
+ Hits         6980    10238     +3258     
- Misses       2327    10697     +8370     
- Partials      118     1573     +1455     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Wazzymandias Wazzymandias merged commit 094fe86 into farcasterxyz:main Jul 3, 2024
9 of 10 checks passed
@Wazzymandias
Copy link
Contributor

Thank you for the fix, appreciate it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants