Docs feedback: CLERK_SECRET_KEY is not findable
This critical (edit: I'm not actually sure which scenarios it is required) environment variable, CLERK_SECRET_KEY, is not in plain text, so therefore not findable in documentation.
It is burned into an image on https://docs.convex.dev/auth/clerk
Convex & Clerk | Convex Developer Hub
Clerk is an authentication platform providing login via
6 Replies
Thanks for posting in <#1088161997662724167>.
Reminder: If you have a Convex Pro account, use the Convex Dashboard to file support tickets.
- Provide context: What are you trying to achieve, what is the end-user interaction, what are you seeing? (full error message, command output, etc.)
- Use search.convex.dev to search Docs, Stack, and Discord all at once.
- Additionally, you can post your questions in the Convex Community's <#1228095053885476985> channel to receive a response from AI.
- Avoid tagging staff unless specifically instructed.
Thank you!
Why were you looking for CLERK_SECRET_KEY, did you need it for setting up some Clerk stuff?
Oh wait a second, is this CLERK_SECRET_KEY environment necessary?
The reason why I was looking for this variable is because my teammate faced an application error in his Amplify deployment of a non-prod branch.
So, in Cloudwatch we saw this error:
2024-12-06T17:42:34.613Z
Error: Missing Clerk Secret Key or API Key. Go to https://dashboard.clerk.com and get your key for your instance.
So then, we reviewed the environment variables in my Amplify app and saw:
CLERK_SECRET_KEY
So then, I went to search.Convex.dev to find the documentation about CLERK_SECRET_KEY so that I made sure it was setup correctly
I found that CLERK_SECRET_KEY was in a screenshot in https://docs.convex.dev/auth/clerk
Convex & Clerk | Convex Developer Hub
Clerk is an authentication platform providing login via
Got it, yeah it's not needed for the simple Convex integration but if you use it for Clerk libraries to do other things it could be.
Oh okay, I don't remember what that environment variable is used for. I also don't know whether CLERK_SECRET_KEY is necessary for the steps in that particular webpage of authentication documentation.
I would say it's worth adding CLERK_SECRET_KEY as plain text, and explaining what its purpose is