docs: explain permissions and use of key

unkeyed · Sep 19, 2024 · c6e26bf · c6e26bf
1 parent 2d89ecd
commit c6e26bf
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/apps/dashboard/lib/env.ts b/apps/dashboard/lib/env.ts
@@ -32,6 +32,10 @@ export const env = () =>
 
       GITHUB_KEYS_URI: z.string().optional(),
 
+      // This key is used for ratelimiting our trpc procedures
+      // It requires the following permissions:
+      // - `ratelimit.*.create_namespace`
+      // - `ratelimit.*.limit`
       UNKEY_ROOT_KEY: z.string().optional(),
     })
     .parse(process.env);