mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
7645140477
For better URLs, the content folder has been renamed 'docs' and all other files have been moved up a level. Also, non-docs images have been moved to the static folder at the top level where they belong. Many relative paths had to be fixed to make this work.
90 lines
3.1 KiB
Markdown
90 lines
3.1 KiB
Markdown
---
|
|
html: configure-the-peer-crawler.html
|
|
parent: configure-peering.html
|
|
seo:
|
|
description: Configure how much information your rippled server reports publicly about its status and peers.
|
|
labels:
|
|
- Core Server
|
|
- Security
|
|
---
|
|
# Configure the Peer Crawler
|
|
|
|
By default, [`rippled` servers](../../../concepts/networks-and-servers/index.md) provide statistics publicly to anyone who asks using the [peer crawler API](../../../references/http-websocket-apis/peer-port-methods/peer-crawler.md), to make it easier to track the health and topology of [the XRP Ledger's peer-to-peer network](../../../concepts/networks-and-servers/peer-protocol.md). You can configure your server to provide more or less information, or to reject peer crawler requests entirely.
|
|
|
|
This document contains steps for two options:
|
|
|
|
- [Change the Information Reported by the Peer Crawler](#change-the-information-reported-by-the-peer-crawler)
|
|
- [Disable the Peer Crawler](#disable-the-peer-crawler)
|
|
|
|
## Change the Information Reported by the Peer Crawler
|
|
|
|
To configure how much information your server provides in response to peer crawler requests, complete the following steps:
|
|
|
|
1. Edit your `rippled`'s config file.
|
|
|
|
```
|
|
vim /etc/opt/ripple/rippled.cfg
|
|
```
|
|
|
|
{% partial file="/docs/_snippets/conf-file-location.md" /%}
|
|
|
|
2. Add or update the `[crawl]` stanza in your config file, and save the changes:
|
|
|
|
```
|
|
[crawl]
|
|
overlay = 1
|
|
server = 1
|
|
counts = 0
|
|
unl = 1
|
|
```
|
|
|
|
The fields in this stanza control which fields the server returns in the [peer crawler response](../../../references/http-websocket-apis/peer-port-methods/peer-crawler.md#response-format). The names of the config fields match the fields of the API response. A setting with a value of `1` means to include the field in the response. A value of `0` means to omit that field from the response. This example shows the default values for each setting.
|
|
|
|
3. After saving the changes to the config file, restart your `rippled` server to apply the updated configuration:
|
|
|
|
```
|
|
systemctl restart rippled
|
|
```
|
|
|
|
|
|
## Disable the Peer Crawler
|
|
|
|
To disable the peer crawler API on your server, so it does not respond to peer crawler requests at all, complete the following steps:
|
|
|
|
1. Edit your `rippled`'s config file.
|
|
|
|
```
|
|
vim /etc/opt/ripple/rippled.cfg
|
|
```
|
|
|
|
{% partial file="/docs/_snippets/conf-file-location.md" /%}
|
|
|
|
2. Add or update the `[crawl]` stanza in your config file, and save the changes:
|
|
|
|
```
|
|
[crawl]
|
|
0
|
|
```
|
|
|
|
Remove or comment out all other contents of the crawl stanza.
|
|
|
|
3. After saving the changes to the config file, restart your `rippled` server to apply the updated configuration:
|
|
|
|
```
|
|
systemctl restart rippled
|
|
```
|
|
|
|
|
|
## See Also
|
|
|
|
- **Concepts:**
|
|
- [Peer Protocol](../../../concepts/networks-and-servers/peer-protocol.md)
|
|
- **Tutorials:**
|
|
- [Manage the rippled Server](../../installation/install-rippled-on-ubuntu.md)
|
|
- **References:**
|
|
- [server_info method][]
|
|
- [peers method][]
|
|
- [Peer Crawler](../../../references/http-websocket-apis/peer-port-methods/peer-crawler.md)
|
|
|
|
{% raw-partial file="/docs/_snippets/common-links.md" /%}
|