Skip to content

Commit

Permalink
Re-add lost docs. (Consensys#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
rain-on authored Apr 11, 2019
1 parent 26b47dc commit c9e9d22
Show file tree
Hide file tree
Showing 3 changed files with 210 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Sign the CLA
=============

This page is the step-by-step guide to signing the Consensys AG
Individual Contributor License Agreement.

1. First and foremost, read [the current version of the CLA].
It is written to be as close to plain English as possible.

2. Make an account on [GitHub] if you don't already have one.

3. After creating your first pull request, you will see a merge
pre-requisite requiring to you read and sign the CLA.

If you have any questions, you can reach us on [Gitter].

[GitHub]: https://github.com/
[the current version of the CLA]: https://gist.github.com/rojotek/978b48a5e8b68836856a8961d6887992
38 changes: 38 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Overview
This project is led by a benevolent dictator (PegaSys) and managed by the community. That is, the community actively contributes to the day-to-day maintenance of the project, but the general strategic line is drawn by the benevolent dictator. In case of disagreement, they have the last word. It is the benevolent dictator’s job to resolve disputes within the community and to ensure that the project is able to progress in a coordinated way. In turn, it is the community’s job to guide the decisions of the benevolent dictator through active engagement and contribution.


# Principles

The community adheres to the following principles:
* Open: EthSigner is open source. See repository guidelines and CLA, below.
* Welcoming and respectful: See Code of Conduct, below.
* Transparent and accessible: Work and collaboration should be done in public.
* Merit: Ideas and contributions are accepted according to their technical merit and alignment with project objectives and design principles.

# Code of Conduct
See [code of conduct]

# Community membership

See [community membership]

# Decision Making
Decision making will be handled by the Approvers (see [community membership]). If consensus cannot be reached, the Benevolent Dictator will provide the final word on the decision.


# CLA

All contributors must sign the CLA, as described in [CLA.md].
## Attribution

This document was influenced by the following:
- Kubernetes community-membership.md, available at [kub community membership].
- Kubernetes governance.md, available at [kub governance]
- OSSWatch Benevolent Dictator Governance Model, available at [oss watch benevolent dictator].

[CLA.md]: /CLA.md
[code of conduct]: /CODE-OF-CONDUCT.md
[oss watch benevolent dictator]: http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel
[kub community membership]: https://raw.githubusercontent.com/kubernetes/community/master/community-membership.md
[kub governance]:https://github.com/kubernetes/community/blob/master/governance.md
154 changes: 154 additions & 0 deletions docs/Reference/EthSigner-CLI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
description: EthSigner command line interface reference
<!--- END of page meta data -->

# EthSigner Command Line

This reference describes the syntax of the EthSigner Command Line Interface (CLI) options.

```
EthSigner --chain-id=<chainId> --downstream-http-port=<port> --key-file=<keyFile> --password-file=<passwordFile> [options]
```

Runs EthSigner transaction signing application.

## Options

### chain-id

Chain ID that is the intended recipient for the signed transactions.

#### Syntax
```
--chain-id=<chainId>
```

#### Example
```
--chain-id=2017
```

### downstream-http-host

Endpoint to which received requests are forwarded. Default is `localhost`.

#### Syntax
```
--downstream-http-host=<downstreamHttpHost>
```

#### Example
```
--downstream-http-host=8.8.8.8
```

### downstream-http-port

Endpoint to which received requests are forwarded.

#### Syntax
```
--downstream-http-port=<downstreamHttpPort>
```

#### Example
```
--downstream-http-port=6174
```

### downstream-http-request-timeout

Timeout period (in milliseconds) for downstream requests. Default is 5000.

#### Syntax
```
--downstream-http-request-timeout=<downstreamHttpRequestTimeout>
```

#### Example
```
--downstream-http-request-timeout=3000
```

### http-listen-host

Host on which JSON-RPC HTTP listens. Default is `localhost`.

#### Syntax
```
--http-listen-host=<httpListenHost>
```

#### Example
```
--http-listen-host=8.8.8.8
```

### http-listen-port

Port on which JSON-RPC HTTP listens. Default is 8545.

#### Syntax
```
--http-listen-port=<httpListenPort>
```

#### Example
```
--http-lisentport=6174
```

### key-file

File containing key used to sign transactions.

#### Syntax
```
-k, --key-file=<keyFile>
```

#### Example
```
--key-file=/Users/me/my_node/transactionKey
```

### password-file

File containing password to decrypt the [key used to sign transactions](#key-file).

#### Syntax
```
-k, --password-file=<passwordFile>
```

#### Example
```
-p, --password-file=/Users/me/my_node/password
```

### logging

Logging verbosity levels. Options are: `OFF`, `FATAL`, `WARN`, `INFO`, `DEBUG`, `TRACE`, `ALL`. The
default is `INFO`.

#### Syntax
```
-l, --logging=<LOG VERBOSITY LEVEL>
```

### help

Displays the help and exits.

#### Syntax
```
-h, --help
```

### version

Displays the version and exits.

#### Syntax
```
-V, --version
```

0 comments on commit c9e9d22

Please sign in to comment.