oneuptime/config.example.env

184 lines
5.7 KiB
Bash
Raw Normal View History

2023-07-17 12:08:02 +00:00
#!/usr/bin/env bash
2023-09-11 14:09:53 +00:00
# Which domain is this server hosted on? replace this with oneuptime.yourdomain.com or yourdomain.com. You can also set it to a server/VM IP address.
DOMAIN=localhost
2023-07-17 12:08:02 +00:00
# Secrets - PLEASE CHANGE THESE. Please change these to something random. All of these can be different values.
2023-07-19 11:01:09 +00:00
ONEUPTIME_SECRET=please-change-this-to-random-value
DATABASE_PASSWORD=please-change-this-to-random-value
CLICKHOUSE_PASSWORD=please-change-this-to-random-value
REDIS_PASSWORD=please-change-this-to-random-value
ENCRYPTION_SECRET=please-change-this-to-random-value
TOKEN_SECRET=please-change-this-to-random-value
2023-07-19 11:59:10 +00:00
GLOBAL_PROBE_1_KEY=please-change-this-to-random-value
GLOBAL_PROBE_2_KEY=please-change-this-to-random-value
2023-08-01 15:41:21 +00:00
MINIO_ROOT_PASSWORD=please-change-this-to-random-value
2023-08-15 14:11:36 +00:00
INTERNAL_SMTP_PASSWORD=please-change-this-to-random-value
2023-07-17 12:08:02 +00:00
2023-08-22 17:44:35 +00:00
# OneUptime Port. This is the port where OneUptime will be hosted on.
ONEUPTIME_HTTP_PORT=80
ONEUPTIME_HTTPS_PORT=443
2023-07-17 12:08:02 +00:00
2023-07-17 16:45:07 +00:00
# If you would like to attach status page to custom domains use this setting.
# For example, lets say you would like the status page to be hosted on status.yourcompany.com, then
2023-07-31 16:10:42 +00:00
# 1. Create a A record in your DNS provider with the name "oneuptime.yourcompany.com" and value to Public IP of the server oneuptime is deployed on.
2023-07-17 16:45:07 +00:00
# 2. Set the STATUS_PAGE_CNAME_RECORD to "oneuptime.yourcompany.com"
2023-07-31 16:10:42 +00:00
# 3. Create CNAME record in your DNS provider with the name "status.yourcompany.com" and value "oneuptime.yourcompany.com"
2023-07-19 11:01:09 +00:00
STATUS_PAGE_CNAME_RECORD=oneuptime.yourcompany.com
2023-07-17 16:45:07 +00:00
2023-07-17 12:30:20 +00:00
# --------------------------------------------- #
2023-07-17 12:08:02 +00:00
# You can safely ignore anything below this line. Keep them as default to make things work.
2023-07-17 12:30:20 +00:00
# --------------------------------------------- #
2023-07-17 12:08:02 +00:00
# This supports test | production | development | ci.
# Development is used for local development. Test is used for insider / beta / staging builds. Production is used for production ready app. ci is for testing in the CI/CD.
2023-07-19 11:01:09 +00:00
ENVIRONMENT=production
2023-07-17 12:08:02 +00:00
2023-07-17 12:30:20 +00:00
# What image should we pull from docker hub. This only applies when the ENVIRONMENT is production or test
2023-07-19 11:01:09 +00:00
APP_TAG=release
2023-07-17 12:08:02 +00:00
2023-07-17 18:50:48 +00:00
# What is the name of the docker-compose project. This is used to prefix the docker containers.
2023-07-19 11:01:09 +00:00
COMPOSE_PROJECT_NAME=oneuptime
2023-07-17 18:50:48 +00:00
2023-07-17 12:08:02 +00:00
# Clickhouse Settings
2023-07-19 11:01:09 +00:00
CLICKHOUSE_USER=default
CLICKHOUSE_DATABASE=oneuptime
2023-08-19 19:49:24 +00:00
CLICKHOUSE_HOST=clickhouse
CLICKHOUSE_PORT=8123
2023-07-17 12:08:02 +00:00
2023-08-01 15:41:21 +00:00
# Minio User Credentials.
MINIO_ROOT_USER=oneuptime
2023-07-17 12:08:02 +00:00
# Postgres DB Settings.
2023-07-19 11:01:09 +00:00
DATABASE_PORT=5432
DATABASE_USERNAME=postgres
DATABASE_NAME=oneuptimedb
DATABASE_HOST=postgres
2023-07-17 12:08:02 +00:00
2023-07-30 13:04:31 +00:00
# Used to connect to managed postgres providers.
# Fill only what your provider needs.
2023-07-31 09:51:17 +00:00
DATABASE_SSL_REJECT_UNAUTHORIZED=false
DATABASE_SSL_CA=
DATABASE_SSL_KEY=
DATABASE_SSL_CERT=
2023-07-30 13:04:31 +00:00
2023-07-17 12:08:02 +00:00
# Redis DB Settings.
2023-07-19 11:01:09 +00:00
REDIS_HOST=redis
REDIS_PORT=6379
REDIS_DB=0
REDIS_USERNAME=default
REDIS_TLS_CA=
REDIS_TLS_SENTINEL_MODE=false
2023-07-17 12:08:02 +00:00
2023-07-19 11:01:09 +00:00
DISABLE_SIGNUP=false
2023-07-17 12:08:02 +00:00
2023-07-30 15:08:53 +00:00
#Ports. Usually they don't need to change.
2023-07-19 11:01:09 +00:00
DASHBOARD_API_PORT=3002
API_DOCS_PORT=1445
WORKFLOW_PORT=3099
2023-07-29 23:03:00 +00:00
LINK_SHORTENER_PORT=3521
2023-07-19 11:01:09 +00:00
ALERT_PORT=3088
PROBE_API_PORT=3400
PROBE_PORT=3500
TEST_SERVER_PORT=3800
FILE_PORT=3125
HOME_PORT=1444
IDENTITY_PORT=3087
NOTIFICATION_PORT=3191
REALTIME_PORT=3300
WORKERS_PORT=3452
ACCOUNTS_PORT=3003
STATUS_PAGE_PORT=3105
DASHBOARD_PORT=3009
2023-08-25 14:20:00 +00:00
ADMIN_DASHBOARD_PORT=3158
2023-07-17 12:08:02 +00:00
2023-08-15 14:11:36 +00:00
2023-07-17 12:08:02 +00:00
# Internal SMTP Server - Haraka
2023-08-15 14:11:36 +00:00
USE_INTERNAL_SMTP=false
# If USE_INTERNAL_SMTP is true then you need to fill these values.
INTERNAL_SMTP_DKIM_PRIVATE_KEY_AS_BASE64=
INTERNAL_SMTP_DKIM_PUBLIC_KEY_AS_BASE64=
INTERNAL_SMTP_EMAIL=test@yourcompany.com
2023-08-15 21:02:30 +00:00
INTERNAL_SMTP_SENDING_DOMAIN=yourcompany.com
2023-08-15 14:11:36 +00:00
# Safely ignore these.
INTERNAL_SMTP_USERNAME=oneuptime
INTERNAL_SMTP_PORT=2525
INTERNAL_SMTP_FROM_NAME=OneUptime
INTERNAL_SMTP_IS_SECURE=false
INTERNAL_SMTP_HOST=haraka
INTERNAL_SMTP_DKIM_SELECTOR=oneuptime
2023-08-15 21:02:30 +00:00
2023-08-15 14:11:36 +00:00
2023-07-17 12:08:02 +00:00
# Licensing Database
2023-07-19 11:01:09 +00:00
AIRTABLE_API_KEY=
AIRTABLE_BASE_ID=
2023-07-17 12:08:02 +00:00
# Plans
2023-07-17 19:17:30 +00:00
# This is in the format of PlanName,PlanIdFromBillingProvider,MonthlySubscriptionPlanAmountInUSD,YearlySubscriptionPlanAmountInUSD,Order,TrialPeriodInDays
2023-07-17 12:08:02 +00:00
# Enterprise plan will have -1 which means custom pricing.
2023-07-19 11:01:09 +00:00
SUBSCRIPTION_PLAN_BASIC=Basic,priceMonthlyId,priceYearlyId,0,0,1,0
SUBSCRIPTION_PLAN_GROWTH=Growth,priceMonthlyId,priceYearlyId,0,0,2,14
SUBSCRIPTION_PLAN_SCALE=Scale,priceMonthlyId,priceYearlyId,0,0,3,0
SUBSCRIPTION_PLAN_ENTERPRISE=Enterprise,priceMonthlyId,priceYearlyId,-1,-1,4,14
2023-07-17 12:08:02 +00:00
2023-07-19 11:01:09 +00:00
DATABASE_BACKUP_DIRECTORY=/Backups
DATABASE_BACKUP_HOST=localhost
DATABASE_BACKUP_PORT=5400
DATABASE_BACKUP_NAME=oneuptimedb
DATABASE_BACKUP_USERNAME=postgres
DATABASE_BACKUP_PASSWORD=${DATABASE_PASSWORD}
2023-07-17 12:08:02 +00:00
2023-07-19 11:01:09 +00:00
DATABASE_RESTORE_DIRECTORY=/Backups
DATABASE_RESTORE_HOST=localhost
DATABASE_RESTORE_PORT=5400
DATABASE_RESTORE_NAME=oneuptimedb
DATABASE_RESTORE_USERNAME=postgres
DATABASE_RESTORE_PASSWORD=${DATABASE_PASSWORD}
DATABASE_RESTORE_FILENAME=db-31.backup
2023-07-17 12:08:02 +00:00
2023-07-19 11:01:09 +00:00
ANALYTICS_KEY=
ANALYTICS_HOST=
2023-07-17 12:08:02 +00:00
2023-07-19 11:01:09 +00:00
DATABASE_MIGRATIONS_HOST=localhost
DATABASE_MIGRATIONS_PORT=5400
2023-07-17 12:08:02 +00:00
# Global Probes
2023-07-17 19:17:30 +00:00
# This is in the format of GLOBAL_PROBE_NAME=ProbeName,ProbeDescription,ProbeKey
2023-07-19 12:06:39 +00:00
GLOBAL_PROBE_1_NAME="Probe-1"
2023-07-19 11:59:10 +00:00
GLOBAL_PROBE_1_DESCRIPTION="Global probe to monitor oneuptime resources"
2023-08-07 14:28:07 +00:00
GLOBAL_PROBE_1_MONITORING_WORKERS=5
2023-08-07 14:22:45 +00:00
GLOBAL_PROBE_1_MONITOR_FETCH_LIMIT=10
2023-07-19 11:59:10 +00:00
2023-07-19 12:06:39 +00:00
GLOBAL_PROBE_2_NAME="Probe-2"
2023-07-19 11:59:10 +00:00
GLOBAL_PROBE_2_DESCRIPTION="Global probe to monitor oneuptime resources"
2023-08-07 14:28:07 +00:00
GLOBAL_PROBE_2_MONITORING_WORKERS=5
2023-08-07 14:22:45 +00:00
GLOBAL_PROBE_2_MONITOR_FETCH_LIMIT=10
2023-07-17 12:08:02 +00:00
2023-07-19 11:01:09 +00:00
SENDGRID_API_KEY=
2023-07-17 12:08:02 +00:00
2023-07-17 19:17:30 +00:00
# METERED PLANS: This is in the format of MONTHLY_PRICE_ID,YEARLY_PRICE_ID,value per unit,unitName
2023-08-04 07:43:15 +00:00
METERED_PLAN_ACTIVE_MONITORING=priceMonthlyId,1,active-monitor,month
2023-07-17 12:08:02 +00:00
2023-07-19 11:01:09 +00:00
SMS_DEFAULT_COST_IN_CENTS=
CALL_DEFAULT_COST_IN_CENTS_PER_MINUTE=
2023-07-17 12:30:20 +00:00
# IS BILLING ENABLED for this installer.
2023-07-19 11:01:09 +00:00
BILLING_ENABLED=false
2023-07-17 12:30:20 +00:00
# Public and private key for billing provider, usually stripe.
2023-07-19 11:01:09 +00:00
BILLING_PUBLIC_KEY=
BILLING_PRIVATE_KEY=
# Use this when you want to disable incident creation.
DISABLE_AUTOMATIC_INCIDENT_CREATION=false