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

docs: document how to deploy the forest explorer on a clean CloudFlare account #86

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lemmih
Copy link
Contributor

@lemmih lemmih commented Dec 6, 2024

Summary of changes

Changes introduced in this pull request:

  • Document the full deployment procedure

Reference issue to close (if applicable)

Closes #74

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code
    adheres to the team's
    documentation standards,
  • I have added tests that prove my fix is effective or that my feature works
    (if possible),

@lemmih lemmih requested a review from a team as a code owner December 6, 2024 12:22
Copy link
Member

@LesnyRumcajs LesnyRumcajs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. KV needs to be created manually in CF and modified in the wrangler file.
  2. There should be a mention of modifying the routes as well, no?
  3. It would be great to change SECRET_WALLET to SECRET_CALIBNET_WALLET here or in a pre-requisite PR.
  4. The pre-requisite of a paid CF plan must be listed - it's not possible to run this out of the box on a free account.
Your worker has access to the following bindings:
- Durable Objects:
  - RATE_LIMITER: RateLimiter

✘ [ERROR] A request to the Cloudflare API (/accounts/fe2fac3a8b68edfa53dc37afa56e26f3/workers/scripts/forest-explorer) failed.

  In order to use Durable Objects, you must switch to a paid plan at
  https://dash.cloudflare.com/fe2fac3a8b68edfa53dc37afa56e26f3/workers/plans [code: 10084]

It's possible to work around this by removing the rate limiter, but the steps and the tradeoff should be mentioned.
5. Let's flesh out the steps with some examples.

Otherwise, I managed to deploy it fine on a free account. I'll create a docker file later to encompass the steps above + software pre-requisites so it's possible to one-line deploy. It would help if one would not have to modify the wrangler file and inject the account and others via environment variables.

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.

Document deployment steps
4 participants