diff --git a/content/tutorials/manage-the-rippled-server/configuration/configure-grpc.md b/content/tutorials/manage-the-rippled-server/configuration/configure-grpc.md new file mode 100644 index 0000000000..51661e8d88 --- /dev/null +++ b/content/tutorials/manage-the-rippled-server/configuration/configure-grpc.md @@ -0,0 +1,55 @@ +# Configure gRPC + +The `rippled` server has an experimental [gRPC API](https://grpc.io/). Currently, this API provides a subset of the full [`rippled` API](rippled-api.html). You can enable the gRPC API on your server with a new configuration stanza. [New in: rippled 1.5.0][] + +**Caution:** gRPC support in `rippled` v1.5.0 is experimental. Configuration settings and API formats are likely to have breaking changes in forthcoming versions. + +## Prerequisites + +To enable gRPC, you must meet the following prerequisites: + +- You must have [installed rippled](install-rippled.html). + +- Your server must be able to bind to the port you choose. The recommended port for gRPC is `50051`. + +## Steps + +To enable gRPC on your server, complete the following steps: + +1. In your `rippled`'s config file, add a `[port_grpc]` configuration stanza. + + [port_grpc] + port = 50051 + ip = 0.0.0.0 + + The configurable fields are as follows: + + - `port` field defines the port the server listens on for gRPC connections from client applications. The recommended port is `50051`. + - `ip` defines which interfaces the server listens on. The value `0.0.0.0` listens on all available network interfaces. To limit connections to just the local loopback network (same machine), use `127.0.0.1` instead. + + {% include '_snippets/conf-file-location.md' %} + +2. Start (or restart) the `rippled` service. + + $ sudo systemctl restart rippled + +## See Also + + + +- **Concepts:** + - [XRP Ledger Overview](xrp-ledger-overview.html) + - [Software Ecosystem](software-ecosystem.html) + - [Parallel Networks](parallel-networks.html) +- **Tutorials:** + - [Get Started with RippleAPI for JavaScript](get-started-with-rippleapi-for-javascript.html) + - [Reliable Transaction Submission](reliable-transaction-submission.html) + - [Manage the rippled Server](manage-the-rippled-server.html) +- **References:** + - [rippled API Reference](rippled-api.html) + - [Ripple Data API v2](data-api.html) + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/dactyl-config.yml b/dactyl-config.yml index a21caa8caf..1d5ba3a962 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2495,6 +2495,17 @@ pages: targets: - ja + - md: tutorials/manage-the-rippled-server/configuration/configure-grpc.md + html: configure-grpc.html + funnel: Docs + doc_type: Tutorials + category: Manage the rippled Server + subcategory: Configuration + blurb: Enable and configure the gRPC API. + targets: + - en + - ja + - md: tutorials/manage-the-rippled-server/configuration/enable-public-signing.md html: enable-public-signing.html funnel: Docs