Operational

DocsGithub Open app

Operational

Github Articles Pitch Usecases Playground API

Contents

Start hereAPI DocsIntroductionSend your first eventEvent parametersStructured EventsActionsContextsCategoriesError handlingManualIntroductionBasicsConventionsSetupTest modeNotificationsPWASelf hostingIntroductionInstall locallyInstall on VPSInstall on RenderInstall via DockerInstall via Docker and CoolifyOnboardingSetup .envIntegrationsBest practicesOtherVisionRoadmapContributing

Setup env vars

Env vars control how the server will function. For hosted deployments, read through the env var documentation - you might need to change a few things around before going into prod.

Backend setup

# REQUIRED. mysql database connection string, eg: mysql://mysql-user:mysql-password@host:port/db-name
DATABASE_URL="mysql://root:gjkesbgkjak@19.43.119.82:2000/operational" 

# Optional. Set vapid details for push notifications. Generate your vapid details from https://tools.reactpwa.com/vapid
VAPID_EMAIL=""
VAPID_PUBLIC_KEY=""
VAPID_PRIVATE_KEY=""

# Nodejs env, defaults to development. Set it to production when hosting online.
NODE_ENV="development"

# Port. Defaults to 2000
PORT="2000"

# Secret hash. DON'T LEAVE THIS EMPTY. Use a random id generator to generate a hash, eg: https://www.uuidgenerator.net/
SECRET=""

# ["http://localhost:8080"] Url of the frontend
APP_URL=""

# ["http://localhost:8080"] Allows cors from this url. If APP_URL is set, that will be used instead.
# Set a cors url to override the current url
# /api/v1/ingest is allowed from all urls so it can receive events without any cors issue.
# Set this value to "*" to allow all urls
CORS=""

# [120] Removes events older than 120 days
REMOVE_EVENTS_AT=""

# [7] Removes old test events older than 7 days
REMOVE_TEST_EVENTS_AT=""


# [""] Set this to the url you've configured in resend(or in your smtp email provider). If not set, emails will saved as txt files inside /backend/private
ADMIN_EMAIL=""

# [""] Use resend.com for email sending. They have a free plan available.
# If you don't want to use resend, get smtp credentials from your email provider and enter them(see smtp env vars below)
RESEND=""

# [""] Set these smtp env vars to the smtp settings of your email provider. For instance, here's resend's docs on smtp: https://resend.com/docs/send-with-smtp
SMTP_HOST=""
SMTP_PORT=""
SMTP_USERNAME=""
SMTP_PASSWORD=""
Copy

App setup

# REQUIRED. Set this the to url your api server is accessible to. Defaults to http://localhost:2000
VITE_API_URL="http://localhost:2000"

# Only set this if you have vapid details. Set this to the value of VAPID_PUBLIC_KEY from your backend .env
VITE_PUSH_SERVER_KEY=""
Copy
OnboardingIntegrations

Operational

Event tracker for your product.

PrivacyTerms
About the product
  • Playground
  • API
  • Pitch
  • Wordpress plugin
  • Bubble plugin
Related to the product
  • VS Logsnag
  • Open Source
  • Articles
Useful articles for your business
  • Force post: The Payment Hack that lets Merchants charge you without approval
  • 6 Best practices for early stage B2B SaaS customer support
  • Setup event notifications for your SaaS
  • How to get high quality users for your B2B SaaS business?