ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-29 16:15:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Re-levelization: move non-docs content, rename content→docs

Browse Source 
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.
This commit is contained in:
mDuo13
2024-01-31 17:53:52 -08:00
parent 971053ebcc
commit 7645140477
844 changed files with 3136 additions and 3458 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/infrastructure/configuration/configure-amendment-voting.md
View File

@@ -66,7 +66,7 @@ Be sure to restart your server for changes to take effect.
## See Also
- [Amendments](../../concepts/networks-and-servers/amendments.md)
- [Known Amendments](../../resources/known-amendments.md)
- [Known Amendments](/resources/known-amendments.md)
- [feature method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/configure-grpc.md
View File

@@ -35,7 +35,7 @@ To enable gRPC on your server, complete the following steps:
- `port` 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. `127.0.0.1` limits connections to the local loopback network (same machine) and is enabled by default. Changing the value to `0.0.0.0` listens on all available network interfaces.
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
2. Start (or restart) the `rippled` service.
@@ -55,4 +55,4 @@ To enable gRPC on your server, complete the following steps:
- **References:**
- [HTTP / WebSocket API Reference](../../references/http-websocket-apis/index.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

2
docs/infrastructure/configuration/configure-statsd.md
View File

@@ -36,7 +36,7 @@ To enable StatsD on your `rippled` server, perform the following steps:
- For the `address`, use the IP address and port where `rippledmon` is listening. By default, this port is 8125.
- For the `prefix`, choose a name that identifies the `rippled` server you are configuring. The prefix must not include whitespace, colons ":", or the vertical bar "|". The prefix appears on all of the StatsD metrics exported from this server.
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
0. Restart the `rippled` service.

4
docs/infrastructure/configuration/connect-your-rippled-to-the-xrp-test-net.md
View File

@@ -22,7 +22,7 @@ To connect your `rippled` server to the XRP Testnet or Devnet, complete these st
Edit your `rippled.cfg` file.
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
<!--{_ }-->
1. Set an `[ips]` stanza with the hub for the network you want to connect to:
@@ -230,4 +230,4 @@ You can use [server_info in the WebSocket Tool](/resources/dev-tools/websocket-a
- **References:**
- [server_info method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/data-retention/configure-advisory-deletion.md
View File

@@ -53,7 +53,7 @@ To configure advisory deletion with a daily schedule, perform the following step
- Set `advisory_delete` to `1` to run online deletion only when prompted. (Set it to `0` to run online deletion automatically as new ledger versions become available.)
- Set `online_delete` to the minimum number of ledger versions to keep after running online deletion. The server accumulates more history than this until online deletion runs.
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
2. Test running the [can_delete method][] to prompt the server to run online deletion.
@@ -130,4 +130,4 @@ If online deletion does not seem to be running after configuring it, try the fol
- [logrotate method][]
- [Ledger Data Formats](../../../references/protocol/ledger-data/index.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/data-retention/configure-full-history.md
View File

@@ -47,7 +47,7 @@ To configure your server to acquire and store full history, complete the followi
**Caution:** If you have any history already downloaded with RocksDB, you must either delete that data or change the paths to the databases in the config file when you switch to NuDB. You must change both the `path` field of the `[node_db]` stanza **and** the `[database_path]` (SQLite database) setting. Otherwise, the server may [fail to start](../../troubleshooting/server-wont-start.md#state-db-error).
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
0. Set the `[ledger_history]` stanza of your server's config file to `full`:
@@ -128,4 +128,4 @@ To configure your server to acquire and store full history, complete the followi
- [Ledger Data Formats](../../../references/protocol/ledger-data/index.md)
- [rippled Commandline Usage Reference](../../commandline-usage.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/data-retention/configure-history-sharding.md
View File

@@ -34,7 +34,7 @@ Before you configure your `rippled` server to store history shards, you must dec
Edit your `rippled.cfg` file to add a `[shard_db]` stanza and optionally a `[historical_shard_paths]` stanza.
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
The following snippet shows an example of a `[shard_db]` stanza:
@@ -86,4 +86,4 @@ To list the shards your server and its peers have available, you can use the [cr
- [crawl_shards method][]
- [Ledger Data Formats](../../../references/protocol/ledger-data/index.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/data-retention/configure-online-deletion.md
View File

@@ -45,7 +45,7 @@ To change the amount of history your server stores, perform the following steps:
Set `online_delete` to the minimum number of ledger versions to keep after running online deletion. With automatic deletion (the default), the server typically runs deletion when it has accumulated about twice this many ledger versions.
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
0. Start (or restart) the `rippled` service.
@@ -87,4 +87,4 @@ To change the amount of history your server stores, perform the following steps:
- [server_info method][]
- [Ledger Data Formats](../../../references/protocol/ledger-data/index.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/data-retention/history-sharding.md
View File

@@ -15,7 +15,7 @@ As XRP Ledger servers run, they naturally produce a database containing data abo
Historical sharding distributes the transaction history of the XRP Ledger into segments, called shards, across servers in the XRP Ledger network. A shard is a range of ledgers. A server uses mostly the same format for ledgers in both the ledger store and the shard store, but the two stores are separate.
[![XRP Ledger Network: Ledger Store and Shard Store Diagram](/img/xrp-ledger-network-ledger-store-and-shard-store.png)](/img/xrp-ledger-network-ledger-store-and-shard-store.png)
[![XRP Ledger Network: Ledger Store and Shard Store Diagram](/docs/img/xrp-ledger-network-ledger-store-and-shard-store.png)](/docs/img/xrp-ledger-network-ledger-store-and-shard-store.png)
<!-- Diagram source: https://docs.google.com/presentation/d/1mg2jZQwgfLCIhOU8Mr5aOiYpIgbIgk3ymBoDb2hh7_s/edit#slide=id.g417450e8da_0_316 -->
@@ -48,4 +48,4 @@ History shards are recorded in a deterministic format, so that any two servers a
- [download_shard method][]
- [Peer Crawler](../../../references/http-websocket-apis/peer-port-methods/peer-crawler.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

6
docs/infrastructure/configuration/data-retention/online-deletion.md
View File

@@ -79,7 +79,7 @@ The following settings relate to online deletion:
The following diagram shows the relationship between `online_delete` and `ledger_history` settings:
[{% inline-svg file="/img/online_delete-vs-ledger_history.svg" /%}](/img/online_delete-vs-ledger_history.svg "Ledgers older than `online_delete` are automatically deleted. Ledgers newer than `ledger_history` are backfilled. Ledgers in between are kept if available but not backfilled")
[{% inline-svg file="/docs/img/online_delete-vs-ledger_history.svg" /%}](/docs/img/online_delete-vs-ledger_history.svg "Ledgers older than `online_delete` are automatically deleted. Ledgers newer than `ledger_history` are backfilled. Ledgers in between are kept if available but not backfilled")
- **`advisory_delete`** - If enabled, online deletion is not scheduled automatically. Instead, an administrator must manually trigger online deletion. Use the value `0` for disabled or `1` for enabled.
@@ -93,7 +93,7 @@ The following settings relate to online deletion:
The following diagram shows how `fetch_depth` works:
[{% inline-svg file="/img/fetch_depth.svg" /%}](/img/fetch_depth.svg "Ledger versions older than fetch_depth are not served to peers")
[{% inline-svg file="/docs/img/fetch_depth.svg" /%}](/docs/img/fetch_depth.svg "Ledger versions older than fetch_depth are not served to peers")
For estimates of how much disk space is required to store different amounts of history, see [Capacity Planning](../../installation/capacity-planning.md#disk-space).
@@ -135,4 +135,4 @@ When it comes time for online deletion, the server first walks through the oldes
- [can_delete method][]
- [ledger_cleaner method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/enable-public-signing.md
View File

@@ -29,7 +29,7 @@ To enable public signing, perform the following steps:
vim /etc/opt/ripple/rippled.cfg
```
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
2. Add the following stanza to your config file, and save the changes:
@@ -58,4 +58,4 @@ To enable public signing, perform the following steps:
- [sign_for method][]
- [submit method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

2
docs/infrastructure/configuration/peering/cluster-rippled-servers.md
View File

@@ -111,4 +111,4 @@ If you run multiple [`rippled` servers](../../../concepts/networks-and-servers/i
- [validation_create method][]
- [peers method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/peering/configure-a-private-server.md
View File

@@ -30,7 +30,7 @@ To set up a specific server as a private peer, complete the following steps:
vim /etc/opt/ripple/rippled.cfg
```
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
2. Enable private peering.
@@ -106,4 +106,4 @@ Be sure the firewall **does not block** outgoing HTTP connections on port 80. Th
- [fetch_info method][]
- [Peer Crawler](../../../references/http-websocket-apis/peer-port-methods/peer-crawler.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

6
docs/infrastructure/configuration/peering/configure-the-peer-crawler.md
View File

@@ -26,7 +26,7 @@ To configure how much information your server provides in response to peer crawl
vim /etc/opt/ripple/rippled.cfg
```
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
2. Add or update the `[crawl]` stanza in your config file, and save the changes:
@@ -57,7 +57,7 @@ To disable the peer crawler API on your server, so it does not respond to peer c
vim /etc/opt/ripple/rippled.cfg
```
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
2. Add or update the `[crawl]` stanza in your config file, and save the changes:
@@ -86,4 +86,4 @@ To disable the peer crawler API on your server, so it does not respond to peer c
- [peers method][]
- [Peer Crawler](../../../references/http-websocket-apis/peer-port-methods/peer-crawler.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/peering/enable-link-compression.md
View File

@@ -20,7 +20,7 @@ To enable link compression on your server, complete the following steps:
$ vim /etc/opt/ripple/rippled.cfg
```
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
### 2. In the config file, add or uncomment the `[compression]` stanza.
@@ -46,4 +46,4 @@ After the restart, your server automatically uses link compression with other pe
- [Capacity Planning](../../installation/capacity-planning.md)
- [Peer Protocol](../../../concepts/networks-and-servers/peer-protocol.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

2
docs/infrastructure/configuration/peering/forward-ports-for-peering.md
View File

@@ -79,4 +79,4 @@ If you are using a hosting service with a virtual firewall (for example, [AWS Se
- [print method][]
- [server_info method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

2
docs/infrastructure/configuration/peering/manually-connect-to-a-specific-peer.md
View File

@@ -73,4 +73,4 @@ rippled connect 169.54.2.151 51235
- [print method][]
- [server_info method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/peering/set-max-number-of-peers.md
View File

@@ -20,7 +20,7 @@ To change the maximum number of peers your server allows, complete the following
$ vim /etc/opt/ripple/rippled.cfg
```
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
2. In the config file, uncomment and edit the `[peers_max]` stanza, or add one if you don't have one already:
@@ -56,4 +56,4 @@ To change the maximum number of peers your server allows, complete the following
- [print method][]
- [server_info method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/infrastructure/configuration/peering/use-a-peer-reservation.md
View File

@@ -65,7 +65,7 @@ If you have already configured your server with a permanent node key pair value,
vim /etc/opt/ripple/rippled.cfg
```
{% partial file="/_snippets/conf-file-location.md" /%}
{% partial file="/docs/_snippets/conf-file-location.md" /%}
3. Add a `[node_seed]` stanza using the `validation_seed` value you generated earlier.
@@ -186,4 +186,4 @@ As a server administrator, you can manage the reservations your server has for o
- [fetch_info method][]
- [Peer Crawler](../../../references/http-websocket-apis/peer-port-methods/peer-crawler.md)
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

2
docs/infrastructure/configuration/server-modes/run-rippled-as-a-stock-server.md
View File

@@ -49,4 +49,4 @@ For more information, see [Troubleshooting `rippled`](../../troubleshooting/inde
- [validator_list_sites method][]
- [validators method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}

2
docs/infrastructure/configuration/server-modes/run-rippled-as-a-validator.md
View File

@@ -303,4 +303,4 @@ For information about how to revoke a master key pair you generated for your val
- [validator_list_sites method][]
- [validators method][]
{% raw-partial file="/_snippets/common-links.md" /%}
{% raw-partial file="/docs/_snippets/common-links.md" /%}