solution: update docs layout to better suit github formatter
This commit is contained in:
@@ -1,6 +1,35 @@
|
||||
= Dshackle Documentation
|
||||
|
||||
include::00-intro.adoc[]
|
||||
== What is Dshackle
|
||||
|
||||
Dshackle is a L7 Load Balancer for Blockchain APIs with automatic discovery, health checking, secure access, TLS with
|
||||
client authentication, and many other features. It can be configured as an edge proxy, middle proxy or API gateway.
|
||||
|
||||
Dshackle provided a high level aggregated API on top of several underlying upstreams (blockchain nodes or providers,
|
||||
such as Geth, Parity, Infura, etc), automatically verifies their availability and the current status of the network,
|
||||
it routes requests to available node, and makes sure the response is consistent and/or data successfully broadcasted to
|
||||
the networks.
|
||||
|
||||
Example use cases:
|
||||
|
||||
- Query for a _transaction_ (block, etc) tries to find it on different nodes and/or retry until it's found or there is
|
||||
a consistent answer from upstreams
|
||||
- Getting _nonce_ to send a transaction makes sure it's larges value over several nodes
|
||||
- Sending _transaction_ distributes it to several nodes in parallel
|
||||
|
||||
Availability and fault tolerance:
|
||||
|
||||
- Dshackle connects to several upstreams via JSON RPC, Websockets or gRPC protocols
|
||||
- It verifies if a node ("upstream") is fully synchronized (not in initial sync mode), has enough peers and its height
|
||||
is not behind other nodes
|
||||
- If an upstream lags behind, lost peers, started to resync, or simply goes down then Dshackle temporarily excludes it from
|
||||
routing and returns back when the the upstream's problem is fixed
|
||||
|
||||
Main goals:
|
||||
|
||||
- stable and fault tolerant access to blockchain nodes
|
||||
- secure connections and authentication
|
||||
- allow to build scalable APIs with nodes distributed over multiple data centers
|
||||
|
||||
== Table of Content
|
||||
|
||||
@@ -15,4 +44,14 @@ include::00-intro.adoc[]
|
||||
. link:09-caching.adoc[Caching]
|
||||
. link:10-client-libraries.adoc[Client Libraries]
|
||||
|
||||
include::99-ending.adoc[]
|
||||
== Chat
|
||||
|
||||
image:https://badges.gitter.im/emeraldpay/community.svg[link="https://gitter.im/emeraldpay/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge]
|
||||
|
||||
== Support
|
||||
|
||||
Contact splix@emeraldpay.io if you want to integrate Dshackle into your project or want to sponsor the development.
|
||||
|
||||
== Links
|
||||
|
||||
- Github: https://github.com/emeraldpay/dshackle
|
||||
Reference in New Issue
Block a user