[{"_1":2,"_174":-5,"_175":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_153":154},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":85,"_106":107,"_144":-5,"_145":11,"_146":17,"_147":11,"_148":-5,"_149":11,"_150":-5,"_151":152},"canonicalUrl","https://hub.docker.com/r/instructure/pandapush/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","instructure","reponame","pandapush","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2018-10-02T17:57:31.24828Z","description","Browser-based, multi-tenant, pub/sub service","is_private","last_updated","2026-02-13T12:30:35.841071Z","last_modified","2026-02-13T12:30:51.494715Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",3059,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Overview\n\nPandapush is an web pub/sub system similar to [Pusher](http://pusher.com/).\n\nCurrently built on [Faye](http://faye.jcoglan.com/) for event routing\nand dispatch. (Pandapush adds a layer of multi-tenancy and\nauthentication.)\n\n## Getting Started\n\n### Using the standalong Docker image\n\n```bash\n$ docker run -ti -p 3000:80 -e AUTH_METHOD=basic -e ADMIN_USERNAME=admin -e ADMIN_PASSWORD=password instructure/pandapush:latest\n```\n\nThis will start Pandapush running on your docker host. If that's\nlocalhost, then access the web ui at http://localhost:49000/admin. Log\nin with `admin`/`password`.\n\n### From the repository, using docker-compose\n\n```bash\n$ docker compose run --rm -u root web chown docker:docker node_modules\n$ docker compose run --rm web npm install\n$ docker compose run --rm webpack npm install\n$ docker compose up\n```\n\nThis will start Pandapush on http://pandapush.docker/admin.\n\n### Create an Application and Key:\n\nCreate an application, and a key.\n\nExamples below will use these values:\n\n| Name | Value |\n| ---------------- | ---------------------------------------- |\n| application name | testapp |\n| application id | fRP0y2aVpYCKiW6PIFOK |\n| key id | PSIDv4ADyV6V9fQ2BgJZ |\n| key secret | aWvMCPXnV599u6hJ71YJqAKSz0t0Lihs09DM92xS |\n| key expires | 2020-01-01T07:00:00.000Z |\n\n### Subscribe to a channel in a browser\n\nUse the client library to subscribe to a public channel (see discussion\nbelow about public vs private).\n\n```html\n\n\n```\n\n```javascript\nvar client = new Pandapush.Client(\"http://localhost:5000/push\");\nclient.subscribe(\"/fRP0y2aVpYCKiW6PIFOK/public/messages\", function(message) {\n console.log(\"got message: \", message);\n});\n```\n\n### Push an event\n\nCreate a token and push an event via HTTP POST.\n\n(We need a library for this for Ruby and Javascript as well.)\n\n```ruby\nrequire 'httparty'\n\nHTTParty.post(\"http://localhost:5000/channel/fRP0y2aVpYCKiW6PIFOK/public/messages\",\n basic_auth: {\n username: 'PSIDv4ADyV6V9fQ2BgJZ',\n password: 'aWvMCPXnV599u6hJ71YJqAKSz0t0Lihs09DM92xS'\n },\n body: {\n # this is your message payload, which can be whatever you want\n foo: \"bar\"\n })\n```\n\nYou should see the message arrive in your browser console.\n\n## Channel Names\n\nChannel names must be formatted as absolute path names whose segments\nmay contains only letters, number, and the symbols -, \\_, and ~.\n\nThe first segment of the channel must be the applicationId, the second\nsegment must be \"public\" or \"private\", and the remainder is up to you:\n\n`//<\"public\" or \"private\">/whatever/you/want`\n\nFor example:\n\n`/fRP0y2aVpYCKiW6PIFOK/private/users/412342/message_count`\n\nThe public/private portion designates whether or not a token is needed\nto subscribe to that channel. Publishing always requires authentication.\n\nThere is another channel type that you'll probably never use: `meta`.\nEvents are pushed to `meta` channels with monitoring information on the\napplication (like # of connected clients). You can't push to `meta`\nchannels.\n\n### Wildcards\n\nYou can also subscribe to all channels under a path using wildcards. Wildcards can\nonly appear as the last path component, and must be either `*` or `**`.\nA single `*` signals to receive messages for all channels under that\npath for a single level, and `**` is recursive.\n\nFor example, if you subscribe to the channel `/users/1/**`,\nyou will receive notifications for `/users/1/foo` and\n`/users/1/foo/bar`. If you subscribe to `/users/1/*` you will receive\npushes for `/users/1/foo` but not `/users/1/foo/bar`.\n\n| | sub `/users/1/*` | sub `/users/1/**` |\n| ----------------------- | ---------------- | ----------------- |\n| push `/users/1` | not received | not received |\n| push `/users/1/foo` | received | received |\n| push `/users/1/foo/bar` | not received | received |\n\n## Authentication\n\nAuthentication is done either by supplying a key and secret or a token\nsigned with a key. The key/secret method can be used for server-side\npushes. Normally you will generate tokens to give to clients in\nbrowsers. (You never want to give your key secret to a browser, as it\nshould be kept... secret.)\n\nTokens are scoped to publishing/subscribing to a specific channel. You\nneed a token to subscribe to `/private/` and `/presence/` channels. Generally, you\nwill be using private channels. You should generate the tokens server\nside, because they require using the token secret to sign.\n\nTokens are [JWTs](http://www.intridea.com/blog/2013/11/7/json-web-token-the-useful-little-standard-you-haven-t-heard-about).\nYou should use a library to generate them. The payload has the contents:\n\n| Field | Required? | Description |\n| -------- | --------- | -------------------------------------------------------------------------------------------- |\n| keyId | required | The id of the key used for signing the token. |\n| channel | required | The channel name the token works for. Must start with `//private/` or `//public/`. |\n| pub | optional | `true` if this token allows publishing. |\n| sub | optional | `true` if this token allows subscribing. Note that `sub` on a public channel is redundant. |\n| presence | optional | An object identifying the user for presence channels. |\n| exp | optional | Unix timestamp of when the token should expire. |\n\n[jwt.io](http://jwt.io) is useful when debugging JSON web tokens.\n\nRuby example:\n\n```ruby\nrequire 'jwt'\n\ntoken = JWT.encode({\n keyId: \"PSIDv4ADyV6V9fQ2BgJZ\",\n channel: \"/fRP0y2aVpYCKiW6PIFOK/public/messages\",\n pub: true\n}, \"aWvMCPXnV599u6hJ71YJqAKSz0t0Lihs09DM92xS\")\n```\n\n## Publishing REST API\n\nIf using a key/secret for auth:\n\n```bash\n$ curl -u : -H \"Content-Type: application/json\" -d '{text:\"hello\"}' https://pp.instructure.com/channel//private/users/123/messages\n```\n\nUsing a token for auth:\n\n```bash\n$ curl -H \"Authorization: Token \" -H \"Content-Type: application/json\" -d '{text:\"hello\"}' https://pp.instructure.com/channel//private/users/123/messages\n```\n\n## Subscribing with the Pandapush client\n\nTo subscribe to private channels, you must specify authentication information.\nThis is easiest to do by using the Pandapush client:\n\n```html\n\n```\n\n```javascript\nconst CHANNEL = \"/applicationid/private/foo\"; // sent by server\nconst TOKEN = \"...\"; // sent by server\nclient = new Pandapush.Client(\"https://pandapush.hostname/push\");\nclient.subscribeTo(CHANNEL, TOKEN, function(message) {\n console.log(\"got message!\");\n});\n```\n\nThe Pandapush client is also a Faye client, and supports all the\nmethod described in the [Faye documentation](http://faye.jcoglan.com/security/authentication.html).\n\n## Presence\n\nPresence is a feature you can use to signal to a group of subscribers\nto a channel who else is subscribed to that channel. Presence channels\nbegin with `/presence/`, and when a user subscribes to a presence\nchannel, they must have a `presence` object in their token that has\nat least an `id` field. For example, the token may be an encoded JWT of:\n\n```json\n{\n \"keyId\": \"PSIDv4ADyV6V9fQ2BgJZ\",\n \"channel\": \"/fRP0y2aVpYCKiW6PIFOK/presence/generaltalk\",\n \"sub\": true,\n \"presence\": {\n \"id\": \"user1\",\n \"name\": \"Joe\",\n \"avatar_url\": \"https://gravatar/foo\"\n }\n}\n```\n\nWhen the client subscribes to the channel `/fRP0y2aVpYCKiW6PIFOK/presence/generaltalk`\nusing the given token, all other subscribers to that channel will receive a\nnotification:\n\n```json\n{\n \"subscribe\": {\n \"user1\": {\n \"id\": \"user1\",\n \"name\": \"Joe\",\n \"avatar_url\": \"https://gravatar/foo\"\n }\n }\n}\n```\n\n\"Joe\" will also receive a callback similar to the one above, but with all\nusers currently subscribed to that channel.\n\nWhen Joe disconnects, all other users will receive a message:\n\n```json\n{\n \"unsubscribe\": {\n \"user1\": null\n }\n}\n```\n\nPresence data should be kept small, as it is persisted in redis in memory.\n\n# Running in Production\n\nThe standalone docker image uses an embedded redis process and sqlite for storing\napplication metadata, but you don't want that in production.\n\n## Redis hosts\n\nYou can specify one or more redis hosts with the `REDIS_HOSTS` environment variable.\nPass `hostname:port` pairs, separated by commas.\n\n## Database (postgres)\n\nYou can specify a postgres database to use with the following environment vars:\n\n```\nDATABASE=postgres\nDATABASE_ADDRESS=\nDATABASE_PORT=\nDATABASE_USERNAME=\nDATABASE_PASSWORD=\nDATABASE_NAME=pandapush\n```\n\nInitialize the database (and apply further migrations) with the following command run\ninside one of your pandapush containers:\n\n```\nknex --knexfile server/knexfile.js migrate:latest\n```\n\n# Mobile\n\nNote that this is _not_ a \"Push Notification\" service like for iOS and\nAndroid. There do appear to be some open-source Faye clients\nfor iOS and Android, but I have not tested any of them.\n\n# Testing\n\n- Run tests in docker compose: `docker compose run --rm web npm run test:coverage`\n\n## Manual Testing\n\nCurrently, there is lots of room for improving our test coverage/quality.\nTherefore, it's important that we manually test the basic pub-sub functionality via the UI as well.\n\n**Prerequisite**: setup dinghy-http-proxy\n\n1. Run dinghy:\n ```shell\n docker run -d --restart=always \\\n -v /var/run/docker.sock:/tmp/docker.sock:ro \\\n -v ~/.dinghy/certs:/etc/nginx/certs \\\n -p 80:80 -p 443:443 -p 19322:19322/udp \\\n -e DNS_IP=127.0.0.1 -e CONTAINER_NAME=http-proxy \\\n --name http-proxy ktgeek/dinghy-http-proxy\n ```\n2. Create `/etc/resolver/docker`\n ```text\n nameserver 127.0.0.1\n port 19322\n ```\n\nAfter setting up dinghy, we can\n\n1. spin up the docker stack: `docker compose up -d`\n2. check out the UI: `open http://pandapush.docker/admin`\n\nFor testing, we can use the existing `devapp`: `open http://pandapush.docker/admin/application/devapp/console`.\n\nSubscribe to a topic and then publish a message. The message should be visible in the bottom of the page.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",72635666687,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":94,"_96":97,"_98":99,"_100":101,"_102":94,"_103":94,"_104":94,"_105":17},"id","f41bcfe005b843eead381c63c6db5236","uuid","f41bcfe0-05b8-43ee-ad38-1c63c6db5236","type","organization","orgname","full_name","","location","company","Instructure","profile_url","http://www.instructure.com/","date_joined","2015-02-18T23:18:35.362253Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[108],{"_109":40,"_110":111,"_112":113,"_114":115,"_86":116,"_117":118,"_46":133,"_134":111,"_135":29,"_136":52,"_53":137,"_138":139,"_140":124,"_141":133,"_142":62,"_143":17},"content_type","creator",223484,"digest","sha256:9d7dac21278adcaccdc0c6f2fadd7e8981a29eaf1dfc32f6c3c4176cee5c274d","full_size",356186343,36566634,"images",[119],{"_120":121,"_112":113,"_122":94,"_123":124,"_125":126,"_127":128,"_129":94,"_130":-5,"_131":115,"_59":62,"_132":-5},"architecture","amd64","features","last_pulled","2026-09-28T20:08:35.454094642Z","last_pushed","2026-02-12T17:53:54.021396505Z","os","linux","os_features","os_version","size","variant","2026-02-13T12:30:34.769361Z","last_updater","last_updater_username","media_type","latest","repository",6088082,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":155,"_162":163,"_151":172,"_173":11},{"_36":156,"_38":157,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":158,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":159,"_75":17,"_76":161,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":160},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_164":60,"_165":-5,"_166":-5,"_167":168},"count","next","previous","results",[169],{"_109":40,"_110":111,"_112":113,"_114":115,"_86":116,"_117":170,"_46":133,"_134":111,"_135":29,"_136":52,"_53":137,"_138":139,"_140":124,"_141":133,"_142":62,"_143":17},[171],{"_120":121,"_112":113,"_122":94,"_123":124,"_125":126,"_127":128,"_129":94,"_130":-5,"_131":115,"_59":62,"_132":-5},[],"canDeleteTags","actionData","errors"]

instructure/pandapush

Tags for instructure/pandapush