Sha256: 0c4786363da27993b6d4f341ab39656b993aa89554d5eac224de0322d74a895a
Contents?: true
Size: 1.87 KB
Versions: 26
Compression:
Stored size: 1.87 KB
Contents
# Springboard
Makes it dead simple to run [elasticsearch](/elasticsearch/elasticsearch)
from your rails project. No external dependencies except java. Just
bundle and go!
Note this is not recommended for use in production environments. Use a
real elasticsearch deployment there. Only use this for development purposes.
## Installation
Add this line to your application's Gemfile:
gem 'springboard'
And then execute:
$ bundle
Or install it yourself as:
$ gem install springboard
## Versioning
Springboard uses elasticsearch version numbers so you can require
specific elasticsearch versions in your Gemfile. Create an issue or pull
request if you need a version of the gem with a particular elasticsearch
version.
Subsequent Springboard releases for the same version will add a
version specifier to the end of the version, eg 0.18.7.1.
## Usage
This gem packages up the elasticsearch binary distribution with a ruby
gem binary on top. It add a config path parameter to the elasticsearch
binary. This makes it easier to put a relative config path on the
command line:
springboard -c config/elasticsearch -f
All other parameters are passed through to the normal elasticsearch
start script.
Note that you almost always want to specify -c. Without it the default
elasticsearch configs are used and your data/logs will go into the gem
path, almost certainly not what you want.
You can run elasticsearch from a Procfile:
es: bundle exec springboard -c config/elasticsearch -f
A rails generator for elasticsearch config files is included. Run:
rails g springboard:config
to install a sane development config in config/elasticsearch.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
Version data entries
26 entries across 26 versions & 1 rubygems