Skip to main content

Environment Variable Setup

This guide will walk you through setting up the environment variables for the AIDBQuery on the Linux machine. Environment variables are dynamic-named values that affect the way processes behave on a computer. They are part of the environment in which a process runs.

Prerequisites​

  • Previous steps

Guides​

tip

An environment variable blue-print was provided on the root directory, ./env. Please fill-in the necessary values. Or your can directly configure it on the runtime. ⚠️ Please do not modify the variable names.

Environment Variable Information​

.evn file is a plain text file that contains key-value pairs of the environment variables. Each key-value pair is separated by an equal sign =. The key-value pair is separated by a new line.

Variable NamesTypeDescriptionExample
DATABASE_URLstring
  • Required
  • MySQL Database
  • Case sensitive
  • Store information
mysql://<username>:<password>@localhost:3306/<database name>
OPENAI_API_KEYstring
  • Required
  • Open AI API key
  • Case sensitive
  • Communication with AI
sk-************2i6TMaabqyT3BlbkFJDwQu6*******
STRIPE_SECRET_KEYstring
  • Only for SaaS mode
  • Stripe Secret Key
  • Case sensitive
  • Payment Gateway
  • Get Here
sk_*********IQUNm2q9BcmT40i5w4XEOu8g****
STRIPE_WEBHOOKS_SECRETstring
  • Only for SaaS mode
  • Stripe Webhook Secret
  • Case sensitive
  • Payment process api
  • Get Here
whsec_******2791f47b154600323acd*****
STRIPE_PRICE_IDstring
  • Only for SaaS mode
  • Stripe subscription price ID
  • Case sensitive
  • Get Here
price_****bSGhxFjEvH****
PINECONE_API_KEYstring
  • Required
  • Pinecone API Key
  • Case sensitive
  • Pinecone for long-term AI vector storage
  • Get Here
6c4f0549-*****-82d3-013a6****
PINECONE_INDEXstring
  • Required
  • Pinecone index name
  • Case sensitive
  • Get Here
aipdfquery
NEXTAUTH_URLstring
  • Required
  • NextAuth.js
  • Case sensitive
  • Your domain name
http://domainname.com
NEXTAUTH_SECRETstring
  • Required
  • NextAuth.js encryption secret
  • Encrypt token
3f9f053b-6604-47d7-b84a-4a3ad1505b0c

Setting up Environment Variables​

Edit the .env file in the root directory with FileZilla.

Resources: