Skip to content

Commit f90e64e

Browse files
Doc updated engine options and edit CLI page (#1041)
* doc updated engine options and edit CLI page Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * minor edit Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * minor edit Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * fix vale install process Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * reviewer comments Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * update engine api page Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * remove engine-rpc-enabled Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> * minor edits Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
1 parent c00753e commit f90e64e

File tree

2 files changed

+137
-93
lines changed

2 files changed

+137
-93
lines changed

docs/HowTo/Interact/APIs/Engine-API.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,18 @@ These [API methods](../../../Reference/Engine-API-Methods.md) are a separate sub
99

1010
## Configure the Engine API
1111

12-
To configure the Engine API, specify the [service ports](#service-ports) and [host allowlist](#host-allowlist).
13-
Also [enable the JSON-RPC](API.md#enabling-api-access).
14-
Ensure the [`ETH` method is enabled](Using-JSON-RPC-API.md#api-methods-enabled-by-default) (it's enabled by default).
12+
To configure the Engine API:
1513

16-
### Service ports
17-
18-
To specify the port the Engine API service listens on, use the
19-
[`--engine-rpc-http-port`](../../../Reference/CLI/CLI-Syntax.md#engine-rpc-http-port) or
20-
[`--engine-rpc-ws-port`](../../../Reference/CLI/CLI-Syntax.md#engine-rpc-ws-port) options.
14+
- [Enable the JSON-RPC API](API.md#enable-api-access).
15+
Ensure the [`ETH` method is enabled](Using-JSON-RPC-API.md#api-methods-enabled-by-default) (it's enabled by default).
16+
- Specify the [service ports](#service-ports).
17+
- Specify the [host allowlist](#host-allowlist).
2118

22-
The default ports are:
19+
### Service ports
2320

24-
* 8550 over HTTP.
25-
* 8551 over WebSocket.
21+
To specify the port the Engine API service listens on for HTTP and WebSocket, use the
22+
[`--engine-rpc-port`](../../../Reference/CLI/CLI-Syntax.md#engine-rpc-port) option.
23+
The default is `8551`.
2624

2725
### Host allowlist
2826

0 commit comments

Comments
 (0)