Skip to main content

Connecting your Application

To deploy Quirrel, first set up your Quirrel server via Docker, Railway or

There are three main environment variables you need to specify in your deployment settings:

VariableMeaningWhere to get
QUIRREL_TOKENaccess token for the Quirrel server.See "Acquire a token" section below
QUIRREL_BASE_URLThe base URL of your application's deployment.You probably know this. Something like
QUIRREL_ENCRYPTION_SECRETA 32-character-long secret used for end-to-end encryption of your jobs.Can be generated using openssl rand -hex 16 or
QUIRREL_API_URLThe endpoint your Quirrel Server is running under, e.g. http://your-quirrel-api-address:9181

After setting these variables, you can deploy your application and Quirrel should be working. If it doesn't, feel free to reach out.

Cron Jobs

If you're using CronJobs(), make sure to run quirrel ci during the deploy process. Make sure to have QUIRREL_API_URL, a QUIRREL_TOKEN and the QUIRREL_BASE_URL set when executing quirrel ci.

"scripts": { "build": "npm run build && quirrel ci" }

If you're on Vercel, you can connect QUIRREL_BASE_URL to your VERCEL_URL. Only do this for preview environments, _not for production*! QUIRREL_BASE_URL is used to determine the deployment that your jobs should be executed on. If you set it to VERCEL_URL, that means all jobs will be executed on the exact deployment that they were created on, excluding them from future bugfixes. To connect QUIRREL_BASE_URL to VERCEL_URL, set its value to @VERCEL_URL (notice the @).

Acquire a token

You can acquire an authentication token from your Quirrel Server by running this command:

curl --user ignored:{PASSPHRASE} -X PUT {QUIRREL_SERVER_URL}/tokens/{NAME_OF_TOKEN}

The fields inside of {} are placeholders and should be replaced by you.