container

Holochain Rust Container

This crate implements a reference container for serving Holochain DNAs.

Install

Our recommended pattern for the installation of the container is to download the binary for your platform from our releases page. Otherwise, you can proceed with the more complex instructions for building from source, below.

Building From Source

These dependencies need to be installed in order to compile, and use holochain_container:

• Rust
  • needs to be the nightly build, so use the following commands, once you have first installed Rust
  • rustup toolchain install nightly
  • rustup default nightly
  • Also, if you are going to be developing Zomes in Rust, install the WASM build target for Rust, by running:
  • rustup target add wasm32-unknown-unknown --toolchain nightly
• Zmq
  • zeromq is a "distributed messaging" software package utilized in the networking stack of Holochain
  • the link above has common platform installation instructions
  • without ZMQ the installation command that follows will fail

To install the latest version of the Holochain container, run the following command in a terminal

$ cargo install holochain_container --force --git https://github.com/holochain/holochain-rust.git --branch develop

The container should then be available from your command line using the holochain_container command.

Run holochain_container --version to confirm that it built.

Usage

The container requires a configuration file to run, you can see a sample here

You can put your configuration file in ~/.holochain/container_config.toml or run holochain_container explicitly with the -c to specify where to find it.

Configuration File Spec

TBD (for now you just have infer from the example!)

Limitations

Currently the container only supports the websocket interface.

Contribute

Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our contributing guidelines for our general practices and protocols on participating in the community.

License

Copyright (C) 2018, Holochain Trust

This program is free software: you can redistribute it and/or modify it under the terms of the license p rovided in the LICENSE file (GPLv3). This program is distributed in the hope that it will be useful, bu t WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Note: We are considering other 'looser' licensing options (like MIT license) but at this stage are using GPL while we're getting the matter sorted out. See this article for some of our thinking on licensing for distributed application frameworks.