Taskforce.sh
  • Documentation
  • Getting started
    • Direct Redis Connection
    • Taskforce connector
  • Account
    • Settings
  • Connections
    • Queues
    • Jobs
    • Workers
  • Metrics
  • Monitoring
    • Enable notifications
      • Slack
      • Pagerduty
    • Connection monitor
    • Failed jobs monitor
    • Missing workers monitor
    • Max Memory monitor
    • Backlog Monitor
  • Alerts
  • Organizations
  • BullMQ Pro
    • Connector Pro
  • On Premises
    • AWS
      • Launch AWS AMI.
      • Create role with SSM permissions
      • Assign SSM Role
      • Configure your instance
        • Create a PostgreSQL instance
        • Configure Auth0
          • Configure API
        • Configure Mailgun
      • Setup loadbalancer
      • Setup route 53
      • Monitors
      • Upgrading
      • Troubleshooting
    • Docker
      • Docker registry
      • Environment variables
      • Docker compose
    • Using the taskforce connector
  • Security primer
  • Troubleshooting
Powered by GitBook
On this page

Was this helpful?

  1. On Premises
  2. Docker

Environment variables

There are a bunch of environment variables that must be set up in order for the instance to run properly.

LICENSE_KEY

HOST

REDIS_URL

POSTGRES_HOST
POSTGRES_USER
POSTGRES_PORT
POSTGRES_DB
POSTGRES_PASSWD

AUTH0_CLIENTID
AUTH0_DOMAIN
AUTH0_AUDIENCE

MAILGUN_API_KEY
MAILGUN_DOMAIN

Let's go through these variables in detail.

License Key

The license key to use with this docker container. The container will exit if it is not able to contact https://taskforce.sh and validate the license.

Host

This variable should point to the actual host running the dashboard, for example: https://my.taskforce.dashboard.com

Redis

The dashboard uses Redis for some internal communication and for the Monitoring and Alerts system. A small instance of about 128Mb RAM will be enough in most cases.

PostgreSQL

There are a few variables used to configure the required postgres database, just fill in the values for your database provider accordingly. You won't need a powerful PostgreSQL instance for the dashboard, any minimal instance will do.

Auth0

Mailgun

Currently the dashboard will be exposed at port 9876, and cannot be configured to a different port.

PreviousDocker registryNextDocker compose

Last updated 1 year ago

Was this helpful?

You will find your license key on your Taskforce.sh .

The authentication of the users is performed by Auth0. If you are not using Auth0 you can just create a free account which will most likely be enough for your needs. There are some steps involved in configuring Auth0 properly, please refer to this .

Mailgun is used for sending alert messages as well as team invitations. You can get a Mailgun account with generous quotas for free, then just follow these .

account
guide
instructions