Skip to content
Permalink
Browse files

docs(readme): move operating instructions into readme

  • Loading branch information...
emschwartz committed Sep 9, 2019
1 parent 500e731 commit 6d6e81222f01699f7b5aa211b401cb18ccf4704c
Showing with 59 additions and 75 deletions.
  1. +59 −6 README.md
  2. +0 −69 docs/operating-manuals.md
@@ -17,23 +17,76 @@
- [Interledger.rs Architecture](./docs/architecture.md)
- [Interledger Forum](https://forum.interledger.org) for general questions about the Interledger Protocol and Project

## Installation
## Installation and Usage

### Docker

Prerequisites:
- Docker

Install

1. `docker pull interledgerrs/node`

Run

1. `docker run -it interledgerrs/node` (append `help node` to see the available options)

### Building From Source

Prerequisites:
- Git
- [Rust](https://www.rust-lang.org/tools/install) - latest stable version

Install and Run:
Install

1. `git clone https://github.com/interledger-rs/interledger-rs && cd interledger-rs`
2. `cargo build` (add `--release` to compile the release version, which is slower to compile but faster to run)
2. `cargo run` (append command line options after a `--` to use the CLI)

## Operating Manuals
Run

`cargo run -- node`

Append the `--help` flag to see available options.

### Configuration

Interledger.rs commands such as `node` and `ethereum-ledger` accept configuration options in the following ways:

1. Environment variables
1. Standard In (stdin)
1. Configuration files
1. Command line arguments

The priority is: Environment Variables > stdin > configuration files > command line arguments.

```bash #
# 1.
# Passing by command line arguments.
# --{parameter name} {value}
cargo run -- node --ilp_address example.alice
# 2.
# Passing by a configuration file in JSON, TOML, YAML format.
# The first argument after subcommands such as `node` is the path to the configuration file.
# Note that in order for a docker image to have access to a local file, it must be included in
# a directory that is mounted as a Volume at `/config`
cargo run -- node config.yml
# 3.
# Passing from STDIN in JSON, TOML, YAML format.
some_command | cargo run -- node
See the [Interledger.rs Operating Manuals](./docs/operating-manuals.md).
# 4.
# passing as environment variables
# {parameter name (typically in capital)}={value}
# note that the parameter names MUST begin with a prefix of "ILP_" e.g. ILP_SECRET_SEED
ILP_ADDRESS=example.alice \
ILP_OTHER_PARAMETER=other_value \
cargo run -- node
```

## Running the Examples
## Examples

See the [examples](./examples/README.md) for demos of Interledger functionality and how to use the Interledger.rs implementation.

This file was deleted.

0 comments on commit 6d6e812

Please sign in to comment.
You can’t perform that action at this time.