# Berkshelf
[![Gem Version](https://img.shields.io/gem/v/berkshelf.svg)][gem]
[![Build Status](https://img.shields.io/travis/berkshelf/berkshelf.svg)][travis]

[gem]: https://rubygems.org/gems/berkshelf
[travis]: https://travis-ci.org/berkshelf/berkshelf

Manage a Cookbook or an Application's Cookbook dependencies

## Installation

**WARNING:** It is advised at this time that you [use Berkshelf 3](https://github.com/berkshelf/berkshelf/wiki/Howto:-Use-the-bleeding-edge). Berkshelf 2 is no longer being actively developed and has a number of significant issues related to dependency resolution that Berkshelf 3 fixes.

### Manually install Gecode (temporary)

The current release candidate of Vagrant Berkshelf requires you to have Gecode installed on your machine. In the future this process will be provided in an easy and automated fashion.

#### OSX

    $ cd $( brew --prefix )
    $ git checkout 3c5ca25 Library/Formula/gecode.rb
    $ brew install gecode

#### Debian and Ubuntu

    $ sudo apt-get install libgecode-dev

##### Source

    $ curl -O http://www.gecode.org/download/gecode-3.7.3.tar.gz
    $ tar zxvf gecode-3.7.3.tar.gz
    $ ./configure --disable-doc-dot \
        --disable-doc-search \
        --disable-doc-tagfile \
        --disable-doc-chm \
        --disable-doc-docset \
        --disable-qt \
        --disable-examples
    $ make
    $ (sudo) make install

### Gem Installation

Add Berkshelf to your repository's `Gemfile`:

```ruby
gem 'berkshelf'
```

Or run it as a standalone:

    $ gem install berkshelf

## Usage

See [berkshelf.com](http://berkshelf.com) for up-to-date usage instructions.

## Supported Platforms

Berkshelf is tested on Ruby 1.9.3, 2.0.0, and JRuby 1.6+.

Ruby 1.9 mode is required on all interpreters.

Ruby 1.9.1 and 1.9.2 are not officially supported. If you encounter problems, please upgrade to Ruby 2.0 or 1.9.3.

## Shell Completion

- [Bash](https://github.com/berkshelf/berkshelf-bash-plugin)
- [ZSH](https://github.com/berkshelf/berkshelf-zsh-plugin)

## Plugins

Please see [Plugins page](https://github.com/berkshelf/berkshelf/blob/master/PLUGINS.md) for more information.

## Configuration

Berkshelf will search in specific locations for a configuration file. In order:

    $PWD/.berkshelf/config.json
    $PWD/berkshelf/config.json
    $PWD/berkshelf-config.json
    $PWD/config.json
    ~/.berkshelf/config.json

You are encouraged to keep project-specific configuration in the `$PWD/.berkshelf` directory. A default configuration file is generated for you, but you can update the values to suit your needs.

## Github Cookbooks

With Berkshelf 3 you can query a Berkshelf-API server (a server which indexes cookbooks from various sources and
hosts it over a REST API) in order to resolve the cookbook dependencies. When you choose to host your own Berkshelf-API
server, you can configure it to also index cookbooks hosted in various Github and/or Github Enterprise organizations.

When doing so you should also configure Berkshelf so it can download cookbooks from your indexed Github organizations:

    {
      "github":[
        {
          "access_token": ""
        },
        {
          "access_token": "",
          "api_endpoint": "https://github.enterprise.local/api/v3",
          "web_endpoint": "https://github.enterprise.local",
          "ssl_verify": true
        }
      ]
    }

The first subsection is used for any organization hosted on github.com. As this is the default, you do not have to set the
endpoint info (these are known values for github.com). The second subsection is used when you also index cookbooks from
organizations hosted on Github Enterprise. In this case you will need to specify the specific endpoint info so Berkshelf
knows where to connect to. You can add as many subsections as you have endpoints.

## SSL Errors

If you have trouble getting Berkshelf to successfully talk to an SSL Chef Server, you can try making sure you
have a certificate bundle available to your shell. `export SSL_CERT_FILE=...path/to/cert/file...`

If you need to disable SSL, you can in `~/.berkshelf/config.json` like so:

    {
      "ssl": {
        "verify": false
      }
    }

## Authors

- Jamie Winsor (<jamie@vialstudios.com>)
- Josiah Kiehl (<jkiehl@riotgames.com>)
- Michael Ivey (<michael.ivey@riotgames.com>)
- Justin Campbell (<justin@justincampbell.me>)
- Seth Vargo (<sethvargo@gmail.com>)

Thank you to all of our [Contributors](https://github.com/berkshelf/berkshelf/graphs/contributors), testers, and users.

If you'd like to contribute, please see our [contribution guidelines](https://github.com/berkshelf/berkshelf/blob/master/CONTRIBUTING.md) first.