Sha256: 41cc7ed46ce5ada4029524822a75fa250d4b51696f8b2be311fca1f294b9aaac

Contents?: true

Size: 1.1 KB

Versions: 4

Compression:

Stored size: 1.1 KB

Contents

Dev::Consul
===========

`Dev::Consul` is a simple wrapper around the Consul binary for development and testing. It bundles all of the published Consul binaries at `Dev::Consul::VERSION` and runs the correct build for the local system.

Note that `Dev::Consul`'s version follows that of Consul.

Consul is maintained by Hashicorp. Please see https://www.consul.io/ for details.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'dev-consul'
```

Or Gemspec:

```ruby
spec.add_development_dependency 'dev-consul', '0.6.4'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install dev-consul

## Usage

Run `bundle exec rake` to launch a local instance of Consul.

To integrate into tests:

```ruby
require 'dev/consul'

RSpec.configure do |config|
  config.before(:suite) do
    Dev::Consul.run

    ## Mute output once the consul server is running
    Dev::Consul.output(false)
  end

  config.after(:suite) do
    Dev::Consul.stop
  end

  ## ...
end
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rapid7/dev-consul.

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
dev-consul-0.6.4.3 README.md
dev-consul-0.6.4.2 README.md
dev-consul-0.6.4.1 README.md
dev-consul-0.6.4 README.md