From 64cbd88af352185aee7cd3b5c42061e0ea5821da Mon Sep 17 00:00:00 2001
From: Hubert Bugaj <lesny.rumcajs+github@gmail.com>
Date: Thu, 9 Jan 2025 12:32:08 +0100
Subject: [PATCH] chore: add more information on custom deployment setup

---
 README.md | 24 ++++++++++++++++++++----
 1 file changed, 20 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 2b28469..e8f88d2 100644
--- a/README.md
+++ b/README.md
@@ -52,7 +52,23 @@ the faucet.
 
 # Custom deployments
 
-To deploy to a new CloudFlare account, change `account_id` in `wrangler.toml`,
-set `SECRET_WALLET` and `SECRET_MAINNET_WALLET` using
-`npx wrangler@latest secret put` (values are exported private keys, see
-`forest-wallet export`), and run `npx wrangler@latest deploy`.
+### Account & domain
+1. In [`wrangler.toml`](./wrangler.toml), set `account_id` to your CloudFlare account ID.
+2. In [`wrangler.toml`](./wrangler.toml), set `pattern` in routes to match your domain.
+
+In order to deploy to a different CloudFlare account, you need to do the following:
+
+### Rate limiter
+If you have a paid CloudFlare account:
+1. Create a KV store in CloudFlare. It can be found under the _Storage & Databases_ tab. The name can be anything.
+2. In [`wrangler.toml`](./wrangler.toml), set `id` in `kv_namespaces` to your KV store id (from step 1).
+
+If you have a free CloudFlare account, you will need to disable the rate limiter. :warning: This is not recommended for production use as it will expose your service to abuse.
+1. In [`wrangler.toml`](./wrangler.toml), remove or comment out `[durable_objects]` and `[migrations]` sections. Additionally, remove `kv_namespaces` from the `[env.quick]` section.
+2. Run `npx wrangler@latest secret put RATE_LIMITER_DISABLED true`.
+
+### Wallets
+Set `SECRET_WALLET` (calibnet) and/or `SECRET_MAINNET_WALLET` (mainnet) using `npx wrangler@latest secret put` (values are exported private keys, see `forest-wallet export`).
+
+### Deployment
+Run `npx wrangler@latest deploy`.