diff --git a/site-cookbooks/ipfs/README.md b/site-cookbooks/ipfs/README.md index 626b630..44797d5 100644 --- a/site-cookbooks/ipfs/README.md +++ b/site-cookbooks/ipfs/README.md @@ -6,12 +6,17 @@ This cookbook installs ipfs and starts it as a daemon ### Platforms -This cookbook is tested on Ubuntu 16.06, 14.04 and Debian 8 using Test Kitchen +This cookbook is tested on Ubuntu 16.06, 14.04 and Debian 8 using Test Kitchen. +It currently only supports 64bit platforms ### Chef - Chef 12.0 or later +### Cookbook dependencies + +- `ark` to download and uncompress the Go IPFS package + ## Usage ### ipfs::default @@ -27,7 +32,29 @@ Just include `ipfs` in your node's `run_list`: } ``` +## Attributes + +- `node.['ipfs']['version']` - the Go IPFS version to download from the official +site (64bit) +- `node['ipfs']['checksum']` - the SHA256 checksum for the package +- `node['ipfs']['config']['swarm']['addr_filter']` - the network ranges to not +connect to. This will stop platforms like Hetzner to block your server +(https://github.com/ipfs/go-ipfs/issues/1226) + ## License and Authors -Authors: Greg Karékinian +Authors: Kosmos +``` +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +```