Falqon Pro

Simple, efficient, and reliable messaging queue for Ruby.

Falqon Pro is a commercial addon for Falqon that offers additional features.

See the documentation for more information on how to use Falqon Pro in your application.

Features

Falqon Pro offers additional features on top of Falqon.

• Web interface: manage queues and messages from a web interface

Get started

• Install Falqon Pro and get working with messaging queues in a heartbeat using the quickstart guide

• Check out the API documentation (Falqon) or API documentation (Falqon Pro) for more information on how to use Falqon Pro in your application

• Check out the CLI documentation (Falqon) or CLI documentation (Falqon Pro) for more information on how to manage queues and messages from the command line

• Read the architecture documentation to learn more about how Falqon works under the hood

Quickstart

Requirements

Falqon Pro requires a Redis 6+ server to be available. Use the docker-compose.yml file to quickly spin up a Redis server.

Installation

Add this line to your application’s Gemfile:

gem "falqon-pro", source: "https://token@gems.falqon.dev/"

And then execute:

bundle install

Or install it yourself as:

gem install falqon-pro --source https://token@gems.falqon.dev/

Falqon Pro automatically requires the falqon gem, so you don’t have to add it to your Gemfile.

Configuration

The default configuration works out of the box with the provided docker-compose.yml file. See configuration if you want to adjust the configuration.

Usage

As a standalone application:

bundle exec falqon web

As a Rails engine (in config/routes.rb):

require "falqon/pro"

mount Falqon::Pro::Web::Application, at: "/falqon"

Development

Use foreman start to start the web server and compilation watch processes in parallel.

To update the falqon gem to the latest master version, run the following commands:

bundle update falqon
bundle exec tapioca gem falqon
git add --all .
git commit -m 'Update falqon to latest master'

Testing

# Run test suite
bundle exec rspec

Releasing

To release a new version, update the version number in lib/falqon/pro/version.rb, update the changelog, commit the files and create a git tag starting with v, and push it to the repository. Github Actions will automatically run the test suite, build the .gem file and push it to GitHub Packages.

Documentation

The documentation in docs/ is automatically built by YARD and pushed to docs.falqon.dev on every push to the main branch. Locally, you can build the documentation using the following commands:

rake yard

In development, you can start a local server to preview the documentation:

yard server --reload

License

The software is available under a commercial license as described in the LICENSE.md file.