Instructions for Self-hosting

[mehmettekn]

Hi @Skn0tt,

Would you consider creating instructions for self-hosting Quirrel? I've been working on setting up a self-hosted instance on fly.io, however, I couldn't get it to work with my Shopify app that's built with Remix.

I followed @m5r's instructions in the link below:
https://dev.to/remixtape/self-hosting-quirrel-5af7

I can't get the self-hosted instance to find the queues in my Remix app. It seems to work in development server but won't work in production.

Thanks!

[Skn0tt]

Hi @mehmettekn! Have you seen https://docs.quirrel.dev/deployment/docker? That guide covers how to self-host via Docker. If you've seen it, let me know what open questions you have.

[mehmettekn]

Thanks for the quick reply. Will take a look at this. Thanks

[mehmettekn]

Hi @Skn0tt!,

I'm not sure what I've got wrong but I've tried going through @m5r's instructions a few times now. I can't view any jobs on the UI (neither on the public nor on my instance).

I enter the Quirrel token and the encryption secret into the connection menu and I get this message right away in the modal:
Please authenticate with your QUIRREL_TOKEN via the top-left connection menu.
What does this mean?

I'd like to share with you some excerpts from the live logs of the Redis and Quirrel instances. It'd be great if you can give me some pointers!

Redis:

$ fly logs -a quirrel-redis-falling-morning-1199

Waiting for logs...

2024-07-10T12:07:59.159 runner[17816226a39978] bos [info] Pulling container image registry.fly.io/quirrel-redis-falling-morning-1199:deployment-01J2E8N9ADJS1491SFMZF0YT6V

2024-07-10T12:08:02.026 runner[17816226a39978] bos [info] Successfully prepared image registry.fly.io/quirrel-redis-falling-morning-1199:deployment-01J2E8N9ADJS1491SFMZF0YT6V (2.867481916s)

2024-07-10T12:08:02.133 runner[17816226a39978] bos [info] Setting up volume 'redis_data'

2024-07-10T12:08:02.133 runner[17816226a39978] bos [info] Uninitialized volume 'redis_data', initializing...

2024-07-10T12:08:02.133 runner[17816226a39978] bos [info] Encrypting volume

2024-07-10T12:08:10.545 runner[17816226a39978] bos [info] Opening encrypted volume

2024-07-10T12:08:12.485 runner[17816226a39978] bos [info] Formatting volume

2024-07-10T12:08:13.304 runner[17816226a39978] bos [info] Configuring firecracker

2024-07-10T12:08:13.372 app[17816226a39978] bos [info] 2024-07-10T12:08:13.371867275 [01J2E8P5CGB0J9F41CPSP7N72B:main] Running Firecracker v1.7.0

2024-07-10T12:08:13.693 app[17816226a39978] bos [info] [ 0.273512] PCI: Fatal: No config space access function found

2024-07-10T12:08:13.964 app[17816226a39978] bos [info] INFO Starting init (commit: ad092ccf)...

2024-07-10T12:08:13.980 app[17816226a39978] bos [info] INFO Mounting /dev/vdc at /data w/ uid: 0, gid: 0 and chmod 0755

2024-07-10T12:08:13.982 app[17816226a39978] bos [info] INFO Resized /data to 1056964608 bytes

2024-07-10T12:08:13.988 app[17816226a39978] bos [info] INFO Preparing to run: `docker-entrypoint.sh start-redis-server.sh` as root

2024-07-10T12:08:13.991 app[17816226a39978] bos [info] INFO [fly api proxy] listening at /.fly/api

2024-07-10T12:08:13.994 app[17816226a39978] bos [info] 2024/07/10 12:08:13 INFO SSH listening listen_address=[fdaa:5:a711:a7b:13:a376:98d0:2]:22 dns_server=[fdaa::3]:53

2024-07-10T12:08:13.997 app[17816226a39978] bos [info] vm.overcommit_memory = 1

2024-07-10T12:08:13.997 app[17816226a39978] bos [info] net.core.somaxconn = 1024

2024-07-10T12:08:14.005 runner[17816226a39978] bos [info] Machine created and started in 14.849s

2024-07-10T12:08:14.016 app[17816226a39978] bos [info] 333:C 10 Jul 2024 12:08:14.016 * oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo

2024-07-10T12:08:14.016 app[17816226a39978] bos [info] 333:C 10 Jul 2024 12:08:14.016 * Redis version=7.2.5, bits=64, commit=00000000, modified=0, pid=333, just started

2024-07-10T12:08:14.016 app[17816226a39978] bos [info] 333:C 10 Jul 2024 12:08:14.016 * Configuration loaded

2024-07-10T12:08:14.016 app[17816226a39978] bos [info] 333:M 10 Jul 2024 12:08:14.016 * monotonic clock: POSIX clock_gettime

2024-07-10T12:08:14.017 app[17816226a39978] bos [info] 333:M 10 Jul 2024 12:08:14.017 * Running mode=standalone, port=6379.

2024-07-10T12:08:14.018 app[17816226a39978] bos [info] 333:M 10 Jul 2024 12:08:14.017 * Server initialized

2024-07-10T12:08:14.019 app[17816226a39978] bos [info] 333:M 10 Jul 2024 12:08:14.019 * Creating AOF base file appendonly.aof.1.base.rdb on server start

2024-07-10T12:08:14.019 app[17816226a39978] bos [info] 333:M 10 Jul 2024 12:08:14.019 * Creating AOF incr file appendonly.aof.1.incr.aof on server start

2024-07-10T12:08:14.019 app[17816226a39978] bos [info] 333:M 10 Jul 2024 12:08:14.019 * Ready to accept connections TCP

Quirrel:

2024-07-10T12:44:31.676 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615471675,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Stale-Checker: Starting."}

2024-07-10T12:44:31.676 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615471676,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Stale-Checker: No stale jobs found."}

2024-07-10T12:44:31.970 app[3d8d7007f6eee8] bos [info] {"level":30,"time":1720615471970,"pid":321,"hostname":"3d8d7007f6eee8","reqId":"req-6m","req":{"method":"GET","url":"/health","hostname":"172.19.134.250:9181","remoteAddress":"172.19.134.249","remotePort":36708},"msg":"incoming request"}

2024-07-10T12:44:31.971 app[3d8d7007f6eee8] bos [info] {"level":30,"time":1720615471971,"pid":321,"hostname":"3d8d7007f6eee8","reqId":"req-6m","res":{"statusCode":200},"responseTime":0.9082509998697788,"msg":"request completed"}

2024-07-10T12:44:32.458 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615472458,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:32.458 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615472458,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Peeking into queue"}

2024-07-10T12:44:32.459 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615472459,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:32.579 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615472579,"pid":321,"hostname":"56833ee0b3d708","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:32.579 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615472579,"pid":321,"hostname":"56833ee0b3d708","module":"owl","msg":"Peeking into queue"}

2024-07-10T12:44:32.580 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615472580,"pid":321,"hostname":"56833ee0b3d708","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:33.459 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615473459,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:33.459 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615473459,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Peeking into queue"}

2024-07-10T12:44:33.459 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615473459,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:33.580 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615473580,"pid":321,"hostname":"56833ee0b3d708","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:33.581 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615473580,"pid":321,"hostname":"56833ee0b3d708","module":"owl","msg":"Peeking into queue"}

2024-07-10T12:44:33.581 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615473581,"pid":321,"hostname":"56833ee0b3d708","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:34.460 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615474460,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:34.460 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615474460,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Peeking into queue"}

2024-07-10T12:44:34.461 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615474461,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:34.582 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615474581,"pid":321,"hostname":"56833ee0b3d708","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:34.582 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615474582,"pid":321,"hostname":"56833ee0b3d708","module":"owl","msg":"Peeking into queue"}

2024-07-10T12:44:34.583 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615474582,"pid":321,"hostname":"56833ee0b3d708","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:35.461 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615475461,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:35.461 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615475461,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","msg":"Peeking into queue"}

2024-07-10T12:44:35.462 app[3d8d7007f6eee8] bos [info] {"level":10,"time":1720615475462,"pid":321,"hostname":"3d8d7007f6eee8","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:35.583 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615475583,"pid":321,"hostname":"56833ee0b3d708","module":"owl","msg":"Checking for jobs"}

2024-07-10T12:44:35.584 app[56833ee0b3d708] bos [info] {"level":10,"time":1720615475584,"pid":321,"hostname":"56833ee0b3d708","module":"owl","result":["empty"],"msg":"Checking for jobs finished"}

2024-07-10T12:44:36.352 app[56833ee0b3d708] bos [info] {"level":30,"time":1720615476352,"pid":321,"hostname":"56833ee0b3d708","reqId":"req-6j","req":{"method":"GET","url":"/health","hostname":"172.19.132.170:9181","remoteAddress":"172.19.132.169","remotePort":47200},"msg":"incoming request"}

I don't know what I could be doing wrong and can't find any information on the logs that helps me! So I'd really appreciate your help!

Thanks!

[Skn0tt]

You need to acquire a token so you can authenticate against the Quirrel instance. See https://docs.quirrel.dev/deployment/connecting#acquire-a-token for how to do that.

[mehmettekn]

Hi @Skn0tt,

Thanks for your reply. I already had the authentication token but I think I was missing the QUIRREL_ENCRYPTION_SECRET from the environment variables. This wasn't included in @m5r's instructions.

I still can't view the jobs on the UI and it also looks like I can't authenticate against the Quirrel instance, although I'm using the token and the encryption secret. One question here: am I supposed to remove the '%' at the end of the token when I enter it in the authentication modal on the UI? I've tried doing this and the modal doesn't re-appear asking me to authenticate. I'm not sure if this works because I can't view any jobs.

Another problem: Since I redeployed my app with the encryption secret variable, I'm getting this error on my app:

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] TypeError: Encryptor is not a constructor

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at getEncryptor (file:///app/build/server/index.js?t=1720682623000:1031:10)

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at new QuirrelClient (file:///app/build/server/index.js?t=1720682623000:1092:22)

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at Queue (file:///app/build/server/index.js?t=1720682623000:1374:19)

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at CronJob (file:///app/build/server/index.js?t=1720682623000:1396:10)

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at file:///app/build/server/index.js?t=1720682623000:1594:19

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at ModuleJob.run (node:internal/modules/esm/module_job:195:25)

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at ModuleLoader.import (node:internal/modules/esm/loader:337:24)

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at importModuleDynamicallyWrapper (node:internal/vm/module:432:15)

2024-07-11T07:27:45.082 app[e286622ef15968] bos [info] at run (/app/node_modules/@remix-run/serve/dist/cli.js:112:15)

2024-07-11T07:27:45.378 app[e286622ef15968] bos [info] INFO Main child exited normally with code: 1

I think this has to do with Vite configuration. I had added Quirrel to ssr as shown below:

export default defineConfig({
  server: {
    port: Number(process.env.PORT || 3000),
    hmr: hmrConfig,
    fs: {
      // See https://vitejs.dev/config/server-options.html#server-fs-allow for more information
      allow: ["app", "node_modules"],
    },
  },
  plugins: [
    remix({
      ignoredRouteFiles: ["**/.*"],
    }),
    tsconfigPaths(),
  ],
  build: {
    assetsInlineLimit: 0,
  },
  ssr: {
    noExternal: [
      "/remix-utils/",
      "quirrel",
    ],
  },
}) satisfies UserConfig;

If I don't include 'quirrel' in ssr, this is the error I get:

2024-07-11T08:04:51.153 app[91852dd2a04e08] bos [info] (node:444) ExperimentalWarning: Importing JSON modules is an experimental feature and might change at any time

2024-07-11T08:04:51.153 app[91852dd2a04e08] bos [info] (Use `node --trace-warnings ...` to show where the warning was created)

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] file:///app/build/server/index.js?t=1720684920000:16

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] import { CronJob } from "quirrel/blitz.mjs";

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] ^^^^^^^

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] SyntaxError: The requested module 'quirrel/blitz.mjs' does not provide an export named 'CronJob'

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] at ModuleJob._instantiate (node:internal/modules/esm/module_job:123:21)

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] at ModuleJob.run (node:internal/modules/esm/module_job:191:5)

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] at ModuleLoader.import (node:internal/modules/esm/loader:337:24)

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] at importModuleDynamicallyWrapper (node:internal/vm/module:432:15)

2024-07-11T08:04:51.282 app[91852dd2a04e08] bos [info] at run (/app/node_modules/@remix-run/serve/dist/cli.js:112:15)

2024-07-11T08:04:52.150 app[91852dd2a04e08] bos [info] INFO Main child exited normally with code: 1

Once again, I'd much appreciate your help.
Thanks!

[Skn0tt]

If the modal doesn‘t reappear, that probably means you were able to authenticate.

Encryption is optional, so let‘s try to solve your problems without encryption turned on first.

You mention that the UI doesn‘t show any Jobs, does your app enqueue any?

[mehmettekn]

Yes. I was able to view the job in queue in the development server. Do I just remove the encryption secret from my app's env variables to turn it off?

…

On Thu, 11 Jul 2024 at 11:23, Simon Knott ***@***.***> wrote: If the modal doesn‘t reappear, that probably means you were able to authenticate. Encryption is optional, so let‘s try to solve your problems without encryption turned on first. You mention that the UI doesn‘t show any Jobs, does your app enqueue any? — Reply to this email directly, view it on GitHub <#1174 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AASGAIJ5S74TDU2VPP232NDZLY6H7AVCNFSM6AAAAABKUJQV26VHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTAMBRHAZTQMY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[mehmettekn]

Hi @Skn0tt,

I ended up implementing another solution for this purpose (target.dev). I was worried that the ESM stuff will be tricky to resolve and I didn't want to spend more time on getting this set up.

Thanks for your help!