README.md
[](http://travis-ci.org/denniskuczynski/beanstalkd_view)
[](https://codeclimate.com/github/denniskuczynski/beanstalkd_view)
Beanstalkd View
===============
A Sinatra app to view/manage beanstalkd queues that can be embedded in a Rails app similar to what's available in Resque.
Configuration
-------------
To use in a Rails app, include the gem in your Gemfile:
``` ruby
gem 'beanstalkd_view'
```
Otherwise, gem install beanstalkd_view
Use the following environment variable to specify the location of the beanstalk server:
``` ruby
ENV['BEANSTALK_URL'] = 'beanstalk://localhost/'
```
This environment variable can be specified per Rails environment. So for instance, the above code could be put into environments/development.rb
This can be a comma separated list, e.g. 'beanstalk://localhost:11300,beanstalk://localhost:11400'
Embedding in a Rails app
------------------------
Add the following to your routes.rb file:
``` ruby
mount BeanstalkdView::Server, :at => "/beanstalkd"
```
(NOTE: You may mount the server at any path, not just /beanstalkd)
You can then browse to your application path to view information about your beanstalkd tubes, i.e.
http://127.0.0.1:3000/beanstalkd
If you wish to authenticate the mounted app with Devise, it would look something like:
``` ruby
devise_for :admin_users, ActiveAdmin::Devise.config
match('/beanstalkd/admin/login' => redirect('/admin/login'))
authenticate :admin_user do
mount BeanstalkdView::Server, at: "/beanstalkd"
end
```
Breaking changes since 2.0.0!
------------------------
As of version 2.0.0, beanstalkd_view no longer supports connection to multiple beanstalkd
servers due to a decision to drop connection pool support in the beaneater gem.
Troubleshooting
------------------------
1. CSS/JS assets not being served in Rails when running behind Apache or Nginx
See http://stackoverflow.com/questions/16167317/sinatra-static-assets-empty/16317727
Running from the command line
------------------------
Run the beanstalkd_view executable, e.g.
```bash
beanstalkd_view
```
or from a Rails app:
```bash
bundle exec beanstalkd_view
```
(This will use the vegas gem to launch the Sinatra app on an available port.)
Alternatively, a Rackup file is provided. To use go to the beanstalkd_view directory and execute:
```
rackup
```
If you run beanstalkd_view from the command line you can specify the URL base path.
Set environment variable with the base URL (don't forget the leading slash '/''):
```ruby
ENV['BEANSTALKD_VIEW_PATH'] = '/path'
```
or
```bash
export BEANSTALKD_VIEW_PATH = '/path'
```
Setting `BEANSTALKD_VIEW_PATH` applies to both `rackup` and `vegas`. The default path is '/'.
Running with Docker
------------------------
You can have a look at beanstalkd_view by running it in a [Docker][1] container:
docker build -t beanstalkd_view git://github.com/denniskuczynski/beanstalkd_view.git
docker run -t -i -p 5678:5678 -e BEANSTALK_URL=beanstalk://172.17.0.2 beanstalkd_view
Most likely you have to adjust BEANSTALK_URL for your setup. You can then access beanstalkd_view on http://localhost:5678
[1]: https://www.docker.io/
Screenshot
------------------------
Building the front-end Javascript
------------------------
This project uses Grunt (http://gruntjs.com/) to manage javascript/css linting, concatenation, and minification, and Bower (https://github.com/bower/bower) to manage Javascript dependencies.
For development, install Grunt and Bower as specified on their websites. Then execute
```ruby
bower install
grunt
```
from the command line after modifying any javascript or css files. The output files will be placed in the lib/beanstalkd_view/resources directory.
Running the tests
------------------------
There are 2 variants of RSpec tests.
* Without beanstalkd running, just execute: rspec spec
* With beanstalkd running (default port), execute: rspec spec --tag requires_beanstalkd
Customization
------------------------
beanstalkd_view provides a way to customize your views.
Set environment variable with desired views path:
```ruby
ENV['BEANSTALKD_VIEW_TEMPLATES'] = File.join("my", "app", "views", "beanstalkd")
```
Then just copy `lib/beanstalkd_view/views/*.erb` and customize them as you want.
If you run beanstalkd_view using the command line you can set the URL base path:
```ruby
ENV['BEANSTALKD_VIEW_PATH'] = '/path'
```
*Note: the environment variables should be set before gem loads.*
License
------------------------
beanstalkd_view is released under the MIT license:
* http://www.opensource.org/licenses/MIT
It makes use of the following components also using the MIT license:
* Sinatra - http://www.sinatrarb.com/
* jQuery - http://jquery.org/
* Bluff JS Graphs - http://bluff.jcoglan.com/
And under the Apache license:
* Twitter Bootstrap - http://twitter.github.com/bootstrap/