From a9b4056fffb7d8e3126b5b836326acb75365086c Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 18 Jun 2015 00:31:11 -0700 Subject: [PATCH] [DOC] rippled - admin command table of contents --- content/rippled.md | 39 ++++++++++++++++----------------------- 1 file changed, 16 insertions(+), 23 deletions(-) diff --git a/content/rippled.md b/content/rippled.md index 802dc8c747..5a8b51e167 100644 --- a/content/rippled.md +++ b/content/rippled.md @@ -26,7 +26,9 @@ https://groups.google.com/forum/#!forum/ripple-server Before you can run any commands against a `rippled` server, you must know which server you are connecting to. Most servers are configured not to accept requests directly from the outside network. -Alternatively, you can [run your own local copy of `rippled`](rippled-setup.html). This is required if you want to access any of the [Admin Commands](#List-of-Admin-Commands). In this case, you should use whatever IP and port you configured the server to bind. (For example, `127.0.0.1:54321`) +Alternatively, you can [run your own local copy of `rippled`](rippled-setup.html). This is required if you want to access any of the [Admin Commands](#List-of-Admin-Commands). In this case, you should use whatever IP and port you configured the server to bind. (For example, `127.0.0.1:54321`) Additionally, in order to access admin functionality, you must connect to on a port/IP address marked as admin in the config file. + +The [example config file](https://github.com/ripple/rippled/blob/d7def5509d8338b1e46c0adf309b5912e5168af0/doc/rippled-example.cfg#L831-L854) listens for connections on the local loopback network (127.0.0.1), with JSON-RPC (HTTP) on port 5005 and WebSocket (WS) on port 6006, and treats all connected clients as admin. @@ -54,22 +56,6 @@ Currently, Ripple Labs maintains a set of public JSON-RPC servers at: These public servers are not for sustained or business use, and they may become unavailable at any time. For regular use, you should run your own `rippled` server or contract someone you trust to do so. -If you are running your own `rippled` server, make sure that you have enabled the JSON-RPC interface in your [rippled.cfg](https://ripple.com/wiki/Rippled.cfg) file, since JSON-RPC is disabled by default. The relevant section is something like this example: - -``` -# [rpc_ip]: -# IP address or domain to bind to allow insecure RPC connections. -# Defaults to not allow RPC connections. -# -# [rpc_port]: -# Port to bind to if allowing insecure RPC connections. -[rpc_ip] -127.0.0.1 - -[rpc_port] -8088 -``` - ### Commandline ### The commandline interface connects to the same service as the JSON-RPC one, so the public servers and server configuration are the same. As a commandline client, `rippled` connects to the local instance. For example: @@ -468,15 +454,22 @@ API methods for the Websocket and JSON-RPC APIs are defined by command names, an * [`get_counts` - Get information about the server's memory usage](#get-counts) * [`ledger_accept` - Close and advance the ledger in stand-alone mode](#ledger-accept) * [`ledger_cleaner` - Configure the ledger cleaner service to check for corrupted data](#ledger-accept) +* [`ledger_request` - Query a peer server for a specific ledger version](#ledger-request) +* [`log_level` - Get or modify log verbosity](#log-level) +* [`logrotate` - Reopen the log file](#logrotate) +* [`peers` - Get information about the peer servers connected](#peers) +* [`print` - Get information about internal subsystems](#print) * [`stop` - Shut down the rippled server](#stop) * [`validation_create` - Generate keys for a new rippled validator](#validation-create) +* [`validation_seed` - Temporarily set key to be used for validating](#validation-seed) * [`wallet_propose` - Generate keys for a new account](#wallet-propose) -The following admin commands are deprecated and may be removed without further notice: `ledger_header`, `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score`, and `wallet_seed`. +The following admin commands are deprecated and may be removed without further notice: -(For UNL management, use the the configuration file. To generate wallet keys, use [`wallet_propose`](#wallet-propose). To get a ledger header, use [`ledger`](#ledger)) +* `ledger_header` - Use the [`ledger` command](#ledger) instead. +* `unl_add`, `unl_delete`, `unl_list`, `unl_load`, `unl_network`, `unl_reset`, `unl_score` - Use the configuration file for UNL management instead. +* `wallet_seed` - Use [`wallet_propose`](#wallet-propose) instead. -For information about other Admin Commands, consult [the old wiki documentation](https://ripple.com/wiki/JSON_Messages). ## Commandline Access ## @@ -486,7 +479,7 @@ The `rippled` application, in addition to acting as a server, can be run (as a s -# Managing Accounts # +# Account Information # Accounts are the core unit of authentication in the Ripple Network. Each account can hold balances in multiple currencies, and all transactions must be signed by an account's secret key. In order for an account to exist in a validated ledger version, it must hold a minimum reserve amount of XRP. (The [reserve for an account](https://ripple.com/wiki/Reserves) increases with the amount of data it is responsible for in the shared ledger.) It is expected that accounts will correspond loosely to individual users. @@ -1958,7 +1951,7 @@ The key generated by this method can also be used as a regular key for an accoun -# Managing Ledgers # +# Ledger Information # The globally-shared ledger is the core of the Ripple Network. Each `rippled` server keeps a current version of the ledger, which contains all the accounts, transactions, offers, and other data in the network in an optimized tree format. As transactions and offers are proposed, each server incorporates them into its current copy of the ledger, closes it periodically, and (if configured) participates in the process of advancing the globally-validated version. After concensus is reached in the network, that ledger version is validated and becomes permanently immutable. Any transactions that were not included in one ledger become candidates to be included in the next validated version. @@ -2845,7 +2838,7 @@ The response follows the [standard format](#response-formatting), with a success -# Managing Transactions # +# Transactions # Transactions are the only thing that can modify the shared global ledger of the Ripple Network. All business on the Ripple Network takes the form of transactions, which include not only payments, but also currency-exchange offers, account settings, and changes to the properties of the network itself (like adopting new features).