​
General Questions

​
My connector failed and the error message in the UI is not enough. How can I debug it?

First, find the CC Pair ID for the connector that is failing. To do this, you can click into the connector from the Existing Connectors page, and then find the ID in the URL in your browser. For example, in the below image, the CC Pair ID is 479. Connector ID Next, we can fetch the relevant logs from the background container using one of the following commands. For both, X should be replaced with the CC Pair ID from the previous step. For Docker Compose: 
docker logs -f $(docker ps -q -f name=onyx-stack-background) 2>&1 | grep "CC Pair: X" &> connector_logs.txt
For Kubernetes: 
> connector_logs.txt && \
for pod in $(kubectl get pods -n onyx -o name | grep background); do \
  echo "=== Logs from $pod ===" >> connector_logs.txt; \
  kubectl logs -n onyx "${pod#pod/}" -c background 2>&1 | grep "CC Pair: X" >> connector_logs.txt; \
done
This will contain the full logs for all runs of the connnector! From there, you can check the logs at the time of failure, or join our Slack channel and we can help you debug!

​
Contribution Questions

​
Why did my PR Vercel build fail? or how can I see the vercel logs for my failed PR deployment?

From the /web directory, run npm run build to see the error.

​
When I change/upgrade authentication methods (e.g. OAuth or Email verification), no accounts are verified and thus can’t log in?

Presuming that all your existing users are ones you want to keep in the system, perform a one time database edit to mark all existing users as verified. UPDATE public.user SET is_verified = true; There will be a friendlier way of handling this in future releases.

​
I’m having trouble sending verification e-mails with Gmail’s SMTP server.

Gmail SMTP integration currently require that you use an “app password”, not your regular user password, to send e-mails. See https://support.google.com/mail/answer/185833 for context. Gmail’s default settings for app passwords are somewhat hidden by default. In addition to the above help link, take note of the following. Under Google Account Settings / Security:
  1. Ensure that two step verification is enabled (required for app passwords to be enabled).
  2. If you have a “Less secure apps” setting and it is off, ensure that it is on.
  3. Getting to the actual app password generation page is somewhat hidden. You can search for “App passwords” at the top of the page, or follow a direct link to https://myaccount.google.com/apppasswords.
  4. For the SMTP_USER variable, enter the full e-mail address of the account you wish to send e-mails from … e.g. “user@gmail.com” (without quotes).
  5. For the SMTP_PASS variable, enter the 16 character app password presented to you when you created it … without spaces. (The default way in which the password is presented to you will copy the password with spaces. The spaces are not part of the app password!)
Note that inviting users currently does NOT send emails, but does allow users to sign up with an invited e-mail address. Verification e-mails are sent when:
  1. Verification emails are enabled in settings.
  2. The user attempts to create an account with an invited e-mail address and clicks on the verification link.

​
How do I use the API key in my requests to my Onyx instance’s server endpoints?

If you are trying to use any Onyx endpoint that requires authorization, such as the Answer with Quote endpoint, ensure that you both:
  1. Have an API key created with the correct permission level. Both Basic and Admin keys can be created.
  2. Send the Authorization header properly.
Authorization: Bearer your_api_key_here