PHPackages gilbitron/sqsd - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Queues & Workers](/categories/queues) 4. / 5. gilbitron/sqsd ActiveLibrary[Queues & Workers](/categories/queues) gilbitron/sqsd ============== A replica of the AWS Elastic Beanstalk worker SQS daemon (sqsd) in PHP 0.1.4(9y ago)332.6k5[2 issues](https://github.com/gilbitron/sqsd/issues)MITPHP Since Apr 27Pushed 9y ago2 watchersCompare [ Source](https://github.com/gilbitron/sqsd)[ Packagist](https://packagist.org/packages/gilbitron/sqsd)[ RSS](/packages/gilbitron-sqsd/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (5)Dependencies (5)Versions (6)Used By (0) SQSD ==== [](#sqsd) While testing a [Laravel](https://laravel.com) app running on [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk/) I came across the situation where I wanted to be able to test how my app would handle interacting with the worker tier SQS daemon (`sqsd`) on my local machine. As `sqsd` is not open source there is currently no official way of doing this. This project ([inspired by others](https://github.com/proofme/sqsd)) is an attempt to replicate the functionality of `sqsd` in PHP for local testing purposes. Note that his library has **no dependency on Laravel** and can be used to test any kind of app. Description ----------- [](#description) [![Sqsd architecture](https://cloud.githubusercontent.com/assets/203882/25480291/1719d8ca-2b40-11e7-8a2c-37831e59559c.png)](https://cloud.githubusercontent.com/assets/203882/25480291/1719d8ca-2b40-11e7-8a2c-37831e59559c.png) The Laravel queue worker operates by polling a queue for jobs and then runs them inline (as the queue worker is part of the application). As `sqsd` is completely separate from any application it works in a different way so that any application can be designed to work with it. Sqsd works by polling a SQS queue for jobs and then `POST`'s them to an endpoint specified in your [Elastic Beanstalk worker environment settings](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#using-features-managing-env-tiers-worker-settings) (default is `http://localhost/`). If a job fails for any reason, then the job is sent to what is called a [Dead Letter Queue](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#worker-deadletter) for manual processing. Another aspect of `sqsd` is that it can read a `cron.yaml` file in the root of your application which specifies [periodic tasks](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#worker-periodictasks) that can be run on a schedule. Sqsd will send a job to the queue every time the schedule is triggered. These jobs will then be processed by `sqsd` like normal, but will be `POST`ed to the path specified in the `cron.yaml` with some extra headers. Requirements ------------ [](#requirements) - PHP >= 5.5.0 - Composer Install & Usage ------------------- [](#install--usage) 1. Clone this repo 2. Copy `.env.example` to `.env` and fill in the details (see below) 3. Run `composer install` 4. Run `php ./bin/sqsd.phar work` To install as a composer dependency: 1. Run `composer require gilbitron/sqsd` 2. Run `php ./vendor/bin/sqsd.phar work` Note: If your're running `sqsd` as a composer dependency you will need to set your environment variables via the command line (see below for more info). Configuration ------------- [](#configuration) Configuration is done by either setting environment variables before running `sqsd` (e.g. `export SQS_QUEUE_URL=https://sqs.us-east-1.amazonaws.com/123456789`) or specifying them in `.env`. Env VariableDescription`AWS_ACCESS_KEY_ID` \*AWS access key ID with SQS permissions`AWS_SECRET_ACCESS_KEY` \*AWS secret access key`SQS_QUEUE_URL` \*The URL of the SQS queue (e.g. `https://sqs.us-east-1.amazonaws.com/123456789`)`SQS_QUEUE_NAME` \*The name of the SQS queue`SQS_QUEUE_REGION` \*The region of the SQS queue (e.g. `us-east-1`)`SQS_MAX_MESSAGES`The maximum number of messages that will be received from the SQS queue at a time (default and max is `10`)`SQS_WAIT_TIME`The length of time in seconds that `sqsd` will wait while polling the SQS queue for messages`SQSD_WORKER_URL`The URL the worker will `POST` to (default is `http://localhost`)`SQSD_WORKER_PATH`The path that will be appended to the worker URL (default is `/`). This is the same as the **HTTP Path** setting in the [Elastic Beanstalk worker environment settings](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#using-features-managing-env-tiers-worker-settings)`SQSD_CRON_PATH`Absolute path to a `cron.yaml` which specifies periodic tasks`SQSD_SLEEP_SECONDS`The time in seconds `sqsd` should sleep between checks (default is `1`)`SQSD_STORAGE_PATH`Path to a writable storage dir (default is `/tmp/sqsd`)Environment variables marked with a \* are required for `sqsd` to work. Building the Phar ----------------- [](#building-the-phar) To build Phar file first you need to [install Box](https://github.com/box-project/box2) then run: ``` box build -v ``` Laravel Tips ------------ [](#laravel-tips) If you're looking for a package that will make Laravel work with `sqsd` I recommend [dusterio/laravel-aws-worker](https://github.com/dusterio/laravel-aws-worker). If you are using this to test a Laravel app, instead of [configuring Supervisor](https://laravel.com/docs/5.4/queues#supervisor-configuration) to run the `aritsan queue:work` command, configure Supervisor to run the `sqsd work` command. Contribute ---------- [](#contribute) So you want to help out? That's awesome. Here is how you can do it: - [Report a bug](https://github.com/gilbitron/sqsd/issues) - [Ask for a feature](https://github.com/gilbitron/sqsd/issues) - [Submit a pull request](https://github.com/gilbitron/sqsd/pulls) If you are submitting a pull request please adhere to the existing coding standards used throughout the code and only submit **1 feature/fix per pull request**. Pull requests containing multiple changes will be rejected. Credits ------- [](#credits) Sqsd was created by [Gilbert Pellegrom](http://gilbert.pellegrom.me) from [Dev7studios](http://dev7studios.co). Released under the MIT license. ### Health Score 32 — LowBetter than 72% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity28 Limited adoption so far Community10 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~2 days Total 5 Last Release 3299d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/20011de485eeea26b5582c75daaab217937832762b5d5f551d34d07f74138bb0?d=identicon)[gilbitron](/maintainers/gilbitron) --- Top Contributors [![gilbitron](https://avatars.githubusercontent.com/u/203882?v=4)](https://github.com/gilbitron "gilbitron (17 commits)") --- Tags awsdaemonelasticbeanstalkphpsqssqsdawssqsworkerdaemonsqsd ### Embed Badge ![Health badge](/badges/gilbitron-sqsd/health.svg) ``` [![Health](https://phpackages.com/badges/gilbitron-sqsd/health.svg)](https://phpackages.com/packages/gilbitron-sqsd) ``` ### Alternatives [dusterio/laravel-aws-worker Run Laravel (or Lumen) tasks and queue listeners inside of AWS Elastic Beanstalk workers 3105.7M](/packages/dusterio-laravel-aws-worker)[shiftonelabs/laravel-sqs-fifo-queue Adds a Laravel queue driver for Amazon SQS FIFO queues. 1556.0M3](/packages/shiftonelabs-laravel-sqs-fifo-queue)[dusterio/laravel-plain-sqs Custom SQS connector for Laravel that supports custom format JSON 1352.7M1](/packages/dusterio-laravel-plain-sqs)[enqueue/sqs Message Queue Amazon SQS Transport 376.3M14](/packages/enqueue-sqs)[bref/symfony-messenger Symfony Messenger bridge to run with SQS and SNS on AWS Lambda with Bref 721.2M6](/packages/bref-symfony-messenger)[joblocal/laravel-sqs-sns-subscription-queue A simple Laravel service provider which adds a new queue connector to handle SNS subscription queues. 48416.3k](/packages/joblocal-laravel-sqs-sns-subscription-queue) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)