StakeSquid/dshackle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update links

Browse Source
This commit is contained in:
Termina1
2024-01-26 14:11:35 +02:00
parent 655f5f7c4a
commit 1091fcdb5e
5 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/01-architecture-intro.adoc
View File

@@ -43,7 +43,7 @@ It provides:
- Routes only realy/alive upstreams, i.e., synchronized and with enough peers - Routes only realy/alive upstreams, i.e., synchronized and with enough peers
- Load Balancing - Load Balancing
- Request Retry on upstream errors - Request Retry on upstream errors
- Local Caching (memory and Redis, see link:10-caching.adoc[Caching]) - Local Caching (memory and Redis, see xref:10-caching.adoc[Caching])
- Broadcasting and Quorum for requests - Broadcasting and Quorum for requests
=== gRPC protocol === gRPC protocol

2
docs/02-quick-start.adoc
View File

@@ -148,4 +148,4 @@ grpcurl -d "{\"type\": 100}" -plaintext 127.0.0.1:2449 emerald.Blockchain/Subscr
The output above is for a _streaming subscription_ to all new blocks on Ethereum Mainnet. The output above is for a _streaming subscription_ to all new blocks on Ethereum Mainnet.
It's one of the services provided by Dshackle, in addition to standard methods provided by RPC JSON of underlying nodes. It's one of the services provided by Dshackle, in addition to standard methods provided by RPC JSON of underlying nodes.
See other enhanced methods in the link:07-methods.adoc[Documentation for Enhanced Methods] See other enhanced methods in the xref:07-methods.adoc[Documentation for Enhanced Methods]

4
docs/03-server-config.adoc
View File

@@ -60,7 +60,7 @@ a| `port: 12449`
a| `tls` a| `tls`
| |
| TLS configuration for gRPC. | TLS configuration for gRPC.
See link:08-authentication.adoc[Authentication] for details See xref:08-authentication.adoc[Authentication] for details
a| `compression` a| `compression`
| |
@@ -195,7 +195,7 @@ a| `enabled: true`
a| `tls` a| `tls`
| |
| TLS configuration for proxy. | TLS configuration for proxy.
See link:08-authentication.adoc[Authentication] for details See xref:08-authentication.adoc[Authentication] for details
a| `routes` a| `routes`
| |

22
docs/README.adoc
View File

@@ -33,20 +33,20 @@ Main goals:
== Table of Content == Table of Content
. link:01-architecture-intro.adoc[Architecture Overview] . xref:01-architecture-intro.adoc[Architecture Overview]
. link:02-quick-start.adoc[Quick Start] . xref:02-quick-start.adoc[Quick Start]
. link:03-server-config.adoc[Server Configuration] . xref:03-server-config.adoc[Server Configuration]
. link:04-upstream-config.adoc[Upstreams Configuration] . xref:04-upstream-config.adoc[Upstreams Configuration]
. link:05-start.adoc[How to launch a server] . xref:05-start.adoc[How to launch a server]
. link:06-monitoring.adoc[Logging & Monitoring] . xref:06-monitoring.adoc[Logging & Monitoring]
. link:07-methods.adoc[API methods] . xref:07-methods.adoc[API methods]
. link:08-authentication.adoc[Authentication] . xref:08-authentication.adoc[Authentication]
. link:09-quorum-and-selectors.adoc[Quorum and Selectors] . xref:09-quorum-and-selectors.adoc[Quorum and Selectors]
. link:10-caching.adoc[Caching] . xref:10-caching.adoc[Caching]
== Reference == Reference
. link:reference-configuration.adoc[Configuration Reference] . xref:reference-configuration.adoc[Configuration Reference]
== Chat == Chat

8
docs/reference-configuration.adoc
View File

@@ -496,7 +496,7 @@ tokens:
---- ----
Tokens config enables tracking of a balance amount in the configured tokens. Tokens config enables tracking of a balance amount in the configured tokens.
After making the configuration above you can request balance (`GetBalance`), or subscribe to balance changes (`SubscribeBalance`), using link:07-methods.adoc[enhanced protocol] After making the configuration above you can request balance (`GetBalance`), or subscribe to balance changes (`SubscribeBalance`), using xref:07-methods.adoc[enhanced protocol]
.Token config .Token config
[cols="2a,7"] [cols="2a,7"]
@@ -591,7 +591,7 @@ signed-response:
|=== |===
See more details at link:07-methods.adoc#signatures[Signed Response] in gRPC Methods. See more details at xref:07-methods.adoc#signatures[Signed Response] in gRPC Methods.
[#cluster] [#cluster]
== Cluster == Cluster
@@ -701,7 +701,7 @@ Enable/disable the upstream.
| no | no
| Key-Value pairs that are assigned to the upstream. | Key-Value pairs that are assigned to the upstream.
Used to select an upstream per-request. Used to select an upstream per-request.
See link:09-quorum-and-selectors.adoc[Quorum and Selectors] See xref:09-quorum-and-selectors.adoc[Quorum and Selectors]
| `options` | `options`
| |
@@ -936,7 +936,7 @@ It's more effective, easier to secure connection, and allows to build a distribu
a| TLC configuration for the connection. a| TLC configuration for the connection.
In general it's an optional configuration, but it's strongly recommended. In general it's an optional configuration, but it's strongly recommended.
Also HTTP2 + gRPC is designed to be used with TLS, and some of the related software is unable to use it without TLS. + Also HTTP2 + gRPC is designed to be used with TLS, and some of the related software is unable to use it without TLS. +
See link:08-authentication.adoc[Authentication] docs and <<tls>>. See xref:08-authentication.adoc[Authentication] docs and <<tls>>.
| `tls.ca` | `tls.ca`
| Path to x509 certificate to verify remote server | Path to x509 certificate to verify remote server