You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/operators/setup/casper-sidecar.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,18 +8,18 @@ title: Sidecar Setup
8
8
9
9
The Casper Sidecar is an application running alongside the node process. It allows subscribers to monitor a node's event stream, query stored events, and query the node's JSON-RPC API, thus receiving faster responses and reducing the load placed on the node. The Sidecar usually runs on the same machine as the node process, but it can be configured to run remotely if necessary. The Sidecar supports the following functionalities:
10
10
11
-
* A [server-sent events (SSE) endpoint](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#the-sse-server) with an `/events` endpoint streaming events from all the connected nodes. The Sidecar also stores these events.
12
-
* A [REST API server](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#the-rest-api-server) that allows clients to query stored events.
13
-
* A [JSON-RPC API](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#the-rpc-api-server) to interact with a Casper node.
14
-
*[Legacy emulation](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/LEGACY_SSE_EMULATION.md) for clients using older versions of the SSE API.
11
+
* A [server-sent events (SSE) endpoint](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#the-sse-server) with an `/events` endpoint streaming events from all the connected nodes. The Sidecar also stores these events.
12
+
* A [REST API server](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#the-rest-api-server) that allows clients to query stored events.
13
+
* A [JSON-RPC API](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#the-rpc-api-server) to interact with a Casper node.
14
+
*[Legacy emulation](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/LEGACY_SSE_EMULATION.md) for clients using older versions of the SSE API.
15
15
16
-
Visit GitHub for the latest source code and information on [system architecture](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#system-components--architecture), [configurations](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#configuring-the-sidecar), [testing](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#running-and-testing-the-sidecar) and [troubleshooting](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#troubleshooting-tips).
16
+
Visit GitHub for the latest source code and information on [system architecture](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#system-components-and-architecture), [configurations](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#configuring-the-sidecar), [testing](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#running-and-testing-the-sidecar) and [troubleshooting](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#troubleshooting-tips).
17
17
18
18

19
19
20
20
## Configuring the Sidecar Service {#configuring-the-sidecar}
21
21
22
-
Operators need to update the Sidecar configuration file according to their needs. Detailed configuration instructions are available in [GitHub](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/resources/ETC_README.md). Further details regarding each [configuration option](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#configuring-the-sidecar) are available in GitHub.
22
+
Operators need to update the Sidecar configuration file according to their needs. Detailed configuration instructions are available in [GitHub](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/resources/ETC_README.md). Further details regarding each [configuration option](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#configuring-the-sidecar) are available in GitHub.
23
23
24
24
## Installing the Sidecar {#installing-the-sidecar}
25
25
@@ -141,12 +141,12 @@ An OpenAPI schema is available at `http://localhost:PORT/api-doc.json/`. The `PO
141
141
142
142
## Using the Sidecar
143
143
144
-
The [Casper Sidecar Usage Guide](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/USAGE.md) describes how to consume events and perform queries using the Sidecar, covering the following topics:
144
+
The [Casper Sidecar Usage Guide](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/USAGE.md) describes how to consume events and perform queries using the Sidecar, covering the following topics:
145
145
146
146
* Node-generated events emitted by the node(s) to which the Sidecar connects
147
147
* Sidecar-generated events originating solely from the Sidecar service and not from a node
148
148
* The RESTful endpoint for performing useful queries about the state of the network
149
149
150
150
## Troubleshooting Tips
151
151
152
-
For troubleshooting tips, visit [Github](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#troubleshooting-tips).
152
+
For troubleshooting tips, visit [Github](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#troubleshooting-tips).
Copy file name to clipboardExpand all lines: versioned_docs/version-2.0.0/operators/setup/casper-sidecar.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,18 +8,18 @@ title: Sidecar Setup
8
8
9
9
The Casper Sidecar is an application running alongside the node process. It allows subscribers to monitor a node's event stream, query stored events, and query the node's JSON-RPC API, thus receiving faster responses and reducing the load placed on the node. The Sidecar usually runs on the same machine as the node process, but it can be configured to run remotely if necessary. The Sidecar supports the following functionalities:
10
10
11
-
* A [server-sent events (SSE) endpoint](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#the-sse-server) with an `/events` endpoint streaming events from all the connected nodes. The Sidecar also stores these events.
12
-
* A [REST API server](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#the-rest-api-server) that allows clients to query stored events.
13
-
* A [JSON-RPC API](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#the-rpc-api-server) to interact with a Casper node.
14
-
*[Legacy emulation](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/LEGACY_SSE_EMULATION.md) for clients using older versions of the SSE API.
11
+
* A [server-sent events (SSE) endpoint](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#the-sse-server) with an `/events` endpoint streaming events from all the connected nodes. The Sidecar also stores these events.
12
+
* A [REST API server](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#the-rest-api-server) that allows clients to query stored events.
13
+
* A [JSON-RPC API](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#the-rpc-api-server) to interact with a Casper node.
14
+
*[Legacy emulation](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/LEGACY_SSE_EMULATION.md) for clients using older versions of the SSE API.
15
15
16
-
Visit GitHub for the latest source code and information on [system architecture](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#system-components--architecture), [configurations](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#configuring-the-sidecar), [testing](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#running-and-testing-the-sidecar) and [troubleshooting](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#troubleshooting-tips).
16
+
Visit GitHub for the latest source code and information on [system architecture](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#system-components-and-architecture), [configurations](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#configuring-the-sidecar), [testing](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#running-and-testing-the-sidecar) and [troubleshooting](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#troubleshooting-tips).
17
17
18
18

19
19
20
20
## Configuring the Sidecar Service {#configuring-the-sidecar}
21
21
22
-
Operators need to update the Sidecar configuration file according to their needs. Detailed configuration instructions are available in [GitHub](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/resources/ETC_README.md). Further details regarding each [configuration option](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#configuring-the-sidecar) are available in GitHub.
22
+
Operators need to update the Sidecar configuration file according to their needs. Detailed configuration instructions are available in [GitHub](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/resources/ETC_README.md). Further details regarding each [configuration option](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#configuring-the-sidecar) are available in GitHub.
23
23
24
24
## Installing the Sidecar {#installing-the-sidecar}
25
25
@@ -141,12 +141,12 @@ An OpenAPI schema is available at `http://localhost:PORT/api-doc.json/`. The `PO
141
141
142
142
## Using the Sidecar
143
143
144
-
The [Casper Sidecar Usage Guide](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/USAGE.md) describes how to consume events and perform queries using the Sidecar, covering the following topics:
144
+
The [Casper Sidecar Usage Guide](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/USAGE.md) describes how to consume events and perform queries using the Sidecar, covering the following topics:
145
145
146
146
* Node-generated events emitted by the node(s) to which the Sidecar connects
147
147
* Sidecar-generated events originating solely from the Sidecar service and not from a node
148
148
* The RESTful endpoint for performing useful queries about the state of the network
149
149
150
150
## Troubleshooting Tips
151
151
152
-
For troubleshooting tips, visit [Github](https://github.com/casper-network/casper-sidecar/blob/feat-2.0/README.md#troubleshooting-tips).
152
+
For troubleshooting tips, visit [Github](https://github.com/casper-network/casper-sidecar/blob/v1.0.4/README.md#troubleshooting-tips).
0 commit comments