consensys / doc.orion Goto Github PK

View Code? Open in Web Editor NEW

5.0 27.0 14.0 1.29 MB

Documentation site for Orion, a ConsenSys Quorum component for doing private transactions

Home Page: https://docs.orion.consensys.net/

License: Apache License 2.0

JavaScript 75.79% Shell 0.01% HTML 23.69% TypeScript 0.08% CSS 0.42%

documentation orion

doc.orion's Introduction

Orion documentation

Orion is a ConsenSys Quorum component for doing private transactions.

The software sources are hosted in https://github.com/ConsenSys/orion

This repository only contains the sources for Orion documentation website hosted by ReadTheDocs.

This repository uses a Git submodule. Please refer to the common tools wiki for explanation about how to build and contribute to this documentation.

doc.orion's People

Contributors

Stargazers

Watchers

Forkers

nicolasmassart bgravenorst madelinemurray lucassaldanha atoulme gridtechs hemantsolo krish1979 macfarla alexandratran rolandtyler isabella232 sfenks61

doc.orion's Issues

Doc persistent nodes and environment variables

PR: Consensys/orion#332

Add diagram for high availability config

@MadelineMurray commented on Wed Apr 08 2020

Like this one but update to match the style of our other diagrams:

Add information on how to customise logging

See https://gitter.im/PegaSysEng/orion?at=5e5e9d47376d882250cbbf22

Add Orion deprecation banner

On :

latest
stable
20.10.1 tag

Add a red deprecation banner on top of each page:

modify header template and use a config variable
add variable in config

Doc how to configure Orion for HA

Add issue and PR templates

Add 2 issue templates:

Doc tool bug report
Doc content issue report

Add 2 PR templates:

Content pull request
DocOps pull request

Hi Contributors,
while implementing the tls logic for Orion transaction Manager, faced an issue with certificate generation. I was following the documentation on the link https://docs.orion.pegasys.tech/en/latest/Tutorials/TLS/ and found an issue with the documentation.
so the nodeurl, clienturl and othernodes should be in a format
nodeurl = “https://:8080/”
clienturl = “https://:8888/”
othernodes = [“https://:8080”]
as without the https:// the orion is not recognizing the string as a URL.

Update doc on configuring DB path when using migration tool

This issue is inspired from customer support ticket 165035

The customer was running migration tool with a wrong BD path so Orion migration created a new empty DB that was not able to migrate.

Modifying orion.conf file to add storage and workdir parameters with absolute paths fixed the issue and made the migration possible.

Another way would have been to run the migration tool from the same place where Orion was running so they get the same default path.

Anyway, it may require to update the migration doc for that to be clearer: https://docs.orion.consensys.net/en/latest/Tutorials/Migrating-from-Orion-to-Tessera/

Flaky test: DualNodesPrivacyGroupsTest

Flaky test

net.consensys.orion.acceptance.send.receive.privacyGroup.DualNodesPrivacyGroupsTest >

https://app.circleci.com/pipelines/github/PegaSysEng/orion/226/workflows/4fb6d1f2-0383-4990-84a8-eb1b5cfb2498/jobs/2104

Update download links

The install binary distribution topics link to Bintray. Update to point to Cloudsmith:

https://cloudsmith.io/~consensys/repos/orion/packages/

Doc Besu <-> Orion TLS

Document how to configure TLS between Besu and Orion.

Current TLS options have been duplicated:
tls --> clientconnectiontls
tlsservertrust --> clientconnectiontlsservertrust
tlsknownclients --> clientconnectiontlsknownclients
tlsservercert --> clientconnectiontlsservercert
tlsserverchain --> clientconnectiontlsserverchain
tlsserverkeuy --> clientconnectiontlsserverkey

Doc missing TLS trust modes

The full list of modes is:
“whitelist”,
“ca”,
“ca-or-whitelist”,
“tofu”,
“insecure-tofa”,
“ca-or-tofu”,
“insecure-ca-or-tofa”,
“insecure-no-validation”,
“insecure-record”,
“insecure-ca-or-record”

See https://docs.orion.pegasys.tech/en/latest/Tutorials/TLS/

Update placeholder TLS diagram

Update the placeholder TLS diagram.

False positive: '/send' should have failed, as the recipient did not receive the payload

Setup using Docker images orchestrated on a programatically created Docker network.

There are two Orions (OrionA and OrionB), with each Orion having a single key pair (privKey, pubKey) and each of their nodeurl set as 0.0.0.0:8080.

A payload with OrionA pubKey as the from and OrionB pubKey is send to OrionA (via /send endpoint) for propagation and returns success, with a receipt, however OrionB cannot find the receipt.

Node StateOrionA /receive with the OrionA pubKey returns 200 & the payload.OrionA /receive with the OrionB pubKey returns 404.OrionB /receive with the OrionA pubKey returns 404.OrionB /receive with the OrionB pubKey returns 404.

HypothesisThe recipients are identified only by nodeUrl, ignoring the publicKey.i.e. when both keys have the same nodeUrl a single positive response is sufficient for the transaction to succeed, despite the fact that node cannot decrypt the second payload (the one encrypted with OrionB's pubKey),