Improve SNAP_ORIGIN documentation (MetaMask#54)

Sovereign-Labs · Aug 29, 2023 · 504e344 · 504e344
1 parent b5146ce
commit 504e344
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/site/.env.production.dist b/packages/site/.env.production.dist
@@ -1 +1,4 @@
+/**
+ * To use this, rename to `.env.production` and set the production SNAP_ORIGIN here
+ */
 SNAP_ORIGIN=
diff --git a/packages/site/src/config/snap.ts b/packages/site/src/config/snap.ts
@@ -1,6 +1,10 @@
 /**
  * The snap origin to use.
  * Will default to the local hosted snap if no value is provided in environment.
+ *
+ * You may be tempted to change this to the URL where your production snap is hosted, but please
+ * don't. Instead, rename `.env.production.dist` to `.env.production` and set the production URL
+ * there. Running `yarn build` will automatically use the production environment variables.
  */
 export const defaultSnapOrigin =
   process.env.SNAP_ORIGIN ?? `local:http://localhost:8080`;