Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.7 KB

example.env.md

File metadata and controls

37 lines (26 loc) · 1.7 KB

.env Sample

The .env file is used to initialize all enviroment variables in the development evironment. A popular solution to how you can organize and maintain your environment variables is to use a .env file. It makes it super easy to have one place where we can quickly read and modify them.

Create the .env file in the root of your app and add your variables and values to it. These are all the variables that are needed by WhatsBot. Description about these can be found in app.json.

SESSION_KEY=""
SESSION_URL=""
PMPERMIT_ENABLED = ""
MONGODB_URL = ""
YT_DATA_API_KEY = ""
DEFAULT_TR_LANG = ""
ENABLE_DELETE_ALERT = ""
OCR_SPACE_API_KEY = ""

It is not mandatory to add all the variables in the .env file. Most of these have a default fallback value mentioned in config.js in case it's not initialized in the dev environment.

At the bare minimum, you need to initialize atleast the following variables to make it work in your local environment.

SESSION_KEY = ""
MONGODB_URL = ""
YT_DATA_API_KEY = ""
OCR_SPACE_API_KEY = ""

  • SESSION_KEY : Your session.secure encryption key.

  • SESSION_URL : You can retrieve your session from an public hosted endpoint, This is just a file and this is secured with SESSION_KEY. Don't put it if you are using VPS or your Local machine.

  • YT_DATA_API_KEY : Youtube DATA API key, grab it from https://cloud.google.com>.

  • OCR_SPACE_API_KEY : Get it from https://ocr.space/OCRAPI.

  • MONGODB_URL : Get it for free from cloud.mongodb.com. For a local mongodb instance in your system, this would be something like mongodb://localhost:MONGO_PORT. If you're using the default port then the url would be mongodb://localhost:27017.