Download the PHP package gilbitron/sqsd without Composer
On this page you can find all versions of the php package gilbitron/sqsd. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sqsd
SQSD
While testing a Laravel app running on AWS Elastic Beanstalk 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) 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
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 (default is http://localhost/). If a job fails for any reason, then the job is sent to what is called a Dead Letter Queue 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 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 POSTed to the path specified in the cron.yaml with some extra headers.
Requirements
- PHP >= 5.5.0
- Composer
Install & Usage
- Clone this repo
- Copy
.env.exampleto.envand fill in the details (see below) - Run
composer install - Run
php ./bin/sqsd.phar work
To install as a composer dependency:
- Run
composer require gilbitron/sqsd - 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 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 Variable | Description |
|---|---|
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 |
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
To build Phar file first you need to install Box then run:
Laravel Tips
If you're looking for a package that will make Laravel work with sqsd I recommend dusterio/laravel-aws-worker.
If you are using this to test a Laravel app, instead of configuring Supervisor to run the aritsan queue:work command, configure Supervisor to run the sqsd work command.
Contribute
So you want to help out? That's awesome. Here is how you can do it:
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
Sqsd was created by Gilbert Pellegrom from Dev7studios. Released under the MIT license.
All versions of sqsd with dependencies
vlucas/phpdotenv Version ^2.4
aws/aws-sdk-php Version ^3.26
symfony/yaml Version ^3.2
mtdowling/cron-expression Version ^1.2