Connects queues to Taskforce
npm install taskforce-connectorThis small service allows you to connect queues to Taskforce acting as a proxy between your queues and the UI. It is useful for connecting local development queues as well as production grade queues without the need of sharing passwords or establishing SSH tunnels.
Currently the connector supports Bull and BullMQ queues.
The connector is designed to be lightweight and using a minimal set of resources from the local queues.
Using yarn
``bash
yarn global add taskforce-connector
`
Using npm:
`bash`
npm install -g taskforce-connector
Call the tool and get a help on the options:
`bash
✗ taskforce --help
Usage: taskforce [options]
Options:
-V, --version output the version number
-n, --name [name] connection name [My Connection] (default: "My Connection")
-t, --token [token] api token (get yours at https://taskforce.sh)
-p, --port [port] redis port [6379] (default: "6379")
--tls [tls] (default: "Activate secured TLS connection to Redis")
-h, --host [host] redis host [localhost] (default: "localhost")
-d, --database [db] redis database [0] (default: "0")
--username [username] redis username
--passwd [passwd] redis password
--spasswd [spasswd] redis sentinel password
-u, --uri [uri] redis uri
--team [team] specify team where to put the connection
-b, --backend [host] backend domain [api.taskforce.sh] (default: "wss://api.taskforce.sh")
-s, --sentinels [host:port] comma-separated list of sentinel host/port pairs
-m, --master [name] name of master node used in sentinel configuration
-h, --help output usage information
--nodes [nodes] comma-separated list of cluster nodes uris to connect to (Redis Cluster)
--queues
--queuesFile
`
Example:
`bash`
✗ taskforce -n "transcoder connection" -t 2cfe6a1b-5f0e-466f-99ad-12f51bea79a7
The token 2cfe6a1b-5f0e-466f-99ad-12f51bea79a7 is a private token that can be retrieved at your Taskforce account.
After running the command, you should be able to see the connection appear automatically on the dashboard.
Sentinel Example:
`bash`
✗ taskforce -n "transcoder connection" -t 2cfe6a1b-5f0e-466f-99ad-12f51bea79a7 -s sentinel1.mydomain:6379,sentinel2.mydomain:6379 -m mymaster
Note: You can also specify the following with environment variables.
`bash`
token TASKFORCE_TOKEN
port REDIS_PORT
host REDIS_HOST
password REDIS_PASSWD
sentinel-password REDIS_SENTINEL_PASSWD
uri REDIS_URI
sentinels REDIS_SENTINELS (comma separated list of sentinels)
master REDIS_MASTER
nodes REDIS_NODES (comma separated list of nodes for Redis Cluster)
To enable use if TLS when using the container set this environment variable:
`bash`
REDIS_USE_TLS=1
Note for Redis Cluster: You may also need to specify following with environment variables.
`bash`
Cluster TLS Certificate REDIS_CLUSTER_TLS
If your redis cluster still cannot connect due to failing certificate validation, you may need to pass this env to skip cert validation.
`bash`
NODE_TLS_REJECT_UNAUTHORIZED="0"
Services that support TLS can also be used using the connector, use the --tls flag. Note that some services such as Heroku expects the port number to be "one more" than the normal unencrypted port read more.
You can use the connector to spawn queue connections to any team that you created on your organization, just pass the team name
as an option:
`bash
✗ taskforce -n "transcoder connection" -t 2cfe6a1b-5f0e-466f-99ad-12f51bea79a7 --team "my awesome team"
`
It is also possible to add the connector as a library:
As a commonjs dependency:
`js
const { Connect } = require("taskforce-connector");
const taskforceConnection = Connect("my connection", "my token", {
host: "my redis host",
port: "my redis port",
password: "my redis password",
});
`
or as a es6 module:
`ts
import { Connect } from "taskforce-connector";
const taskforceConnection = Connect("my connection", "my token", {
host: "my redis host",
port: "my redis port",
password: "my redis password",
});
`
You can also pass an existing IORedis instance instead of connection options. This is useful when you need more control over the Redis connection configuration:
`ts
import { Connect } from "taskforce-connector";
import Redis from "ioredis";
// Create your own Redis instance with custom configuration
const redisClient = new Redis({
host: "my redis host",
port: 6379,
password: "my redis password",
// Any other IORedis options...
maxRetriesPerRequest: null,
enableReadyCheck: false,
});
const taskforceConnection = Connect("my connection", "my token", redisClient);
`
This also works with Redis Cluster:
`ts
import { Connect } from "taskforce-connector";
import Redis from "ioredis";
const cluster = new Redis.Cluster([
{ host: "node1", port: 6379 },
{ host: "node2", port: 6379 },
]);
const taskforceConnection = Connect("my connection", "my token", cluster);
`
If you are using the On Premises version of Taskforce, you can also specify the backend domain:
`ts``
const taskforceConnection = Connect(
"my connection",
"my token",
{
host: "my redis host",
port: "my redis port",
password: "my redis password",
},
"My Prod Team", // optional team name
"wss://mybackend.domain"
);