github.com/shrimpyuk/bor@v0.2.15-0.20220224151350-fb4ec6020bae/docs/cli/server.md (about)

     1  
     2  # Server
     3  
     4  The ```bor server``` command runs the Bor client.
     5  
     6  ## General Options
     7  
     8  - ```chain```: Name of the chain to sync (mainnet or mumbai).
     9  
    10  - ```log-level```: Set log level for the server (info, warn, debug, trace).
    11  
    12  - ```datadir```: Path of the data directory to store information (defaults to $HOME).
    13  
    14  - ```config```: List of files that contain the configuration.
    15  
    16  - ```syncmode```: Blockchain sync mode ("fast", "full", "snap" or "light").
    17  
    18  - ```gcmode```: Blockchain garbage collection mode ("full", "archive").
    19  
    20  - ```whitelist```: Comma separated block number-to-hash mappings to enforce (<number>=<hash>).
    21  
    22  - ```snapshot```: Enables snapshot-database mode (default = enable).
    23  
    24  - ```bor.heimdall```: URL of Heimdall service.
    25  
    26  - ```bor.withoutheimdall```: Run without Heimdall service (for testing purpose).
    27  
    28  - ```ethstats```: Reporting URL of a ethstats service (nodename:secret@host:port).
    29  
    30  - ```gpo.blocks```: Number of recent blocks to check for gas prices.
    31  
    32  - ```gpo.percentile```: Suggested gas price is the given percentile of a set of recent transaction gas prices.
    33  
    34  - ```gpo.maxprice```: Maximum gas price will be recommended by gpo.
    35  
    36  - ```gpo.ignoreprice```: Gas price below which gpo will ignore transactions.
    37  
    38  - ```grpc.addr```: Address and port to bind the GRPC server.
    39  
    40  ### Transaction Pool Options
    41  
    42  - ```txpool.locals```: Comma separated accounts to treat as locals (no flush, priority inclusion).
    43  
    44  - ```txpool.nolocals```: Disables price exemptions for locally submitted transactions
    45  
    46  - ```txpool.journal```: Disk journal for local transaction to survive node restarts
    47  
    48  - ```txpool.rejournal```: Time interval to regenerate the local transaction journal
    49  
    50  - ```txpool.pricelimit```: Minimum gas price limit to enforce for acceptance into the pool
    51  
    52  - ```txpool.pricebump```: Price bump percentage to replace an already existing transaction
    53  
    54  - ```txpool.accountslots```: Minimum number of executable transaction slots guaranteed per account
    55  
    56  - ```txpool.globalslots```: Maximum number of executable transaction slots for all accounts
    57  
    58  - ```txpool.accountqueue```: Maximum number of non-executable transaction slots permitted per account
    59  
    60  - ```txpool.globalqueue```: Maximum number of non-executable transaction slots for all accounts
    61  
    62  - ```txpool.lifetime```: Maximum amount of time non-executable transaction are queued
    63  
    64  ### Sealer Options
    65  
    66  - ```mine```: Enable sealing.
    67  
    68  - ```miner.etherbase```: Public address for block mining rewards (default = first account)
    69  
    70  - ```miner.extradata```: Block extra data set by the miner (default = client version).
    71  
    72  - ```miner.gaslimit```: Target gas ceiling for mined blocks.
    73  
    74  - ```miner.gasprice```: Minimum gas price for mining a transaction.
    75  
    76  ### Cache Options
    77  
    78  - ```cache```: Megabytes of memory allocated to internal caching (default = 4096 mainnet full node).
    79  
    80  - ```cache.database```: Percentage of cache memory allowance to use for database io.
    81  
    82  - ```cache.trie```: Percentage of cache memory allowance to use for trie caching (default = 15% full mode, 30% archive mode).
    83  
    84  - ```cache.trie.journal```: Disk journal directory for trie cache to survive node restarts.
    85  
    86  - ```cache.trie.rejournal```: Time interval to regenerate the trie cache journal.
    87  
    88  - ```cache.gc```: Percentage of cache memory allowance to use for trie pruning (default = 25% full mode, 0% archive mode).
    89  
    90  - ```cache.snapshot```: Percentage of cache memory allowance to use for snapshot caching (default = 10% full mode, 20% archive mode).
    91  
    92  - ```cache.noprefetch```: Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data).
    93  
    94  - ```cache.preimages```: Enable recording the SHA3/keccak preimages of trie keys.
    95  
    96  - ```txlookuplimit```: Number of recent blocks to maintain transactions index for (default = about one year, 0 = entire chain).
    97  
    98  ### JsonRPC Options
    99  
   100  - ```rpc.gascap```: Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite).
   101  
   102  - ```rpc.txfeecap```: Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap).
   103  
   104  - ```ipcdisable```: Disable the IPC-RPC server.
   105  
   106  - ```ipcpath```: Filename for IPC socket/pipe within the datadir (explicit paths escape it).
   107  
   108  - ```jsonrpc.corsdomain```: Comma separated list of domains from which to accept cross.
   109  
   110  - ```jsonrpc.vhosts```: Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.
   111  
   112  - ```http```: Enable the HTTP-RPC server.
   113  
   114  - ```http.addr```: HTTP-RPC server listening interface.
   115          
   116  - ```http.port```: HTTP-RPC server listening port.
   117          
   118  - ```http.rpcprefix```: HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
   119  
   120  - ```http.modules```: API's offered over the HTTP-RPC interface.
   121  
   122  - ```ws```: Enable the WS-RPC server.
   123  
   124  - ```ws.addr```: WS-RPC server listening interface.
   125  
   126  - ```ws.port```: WS-RPC server listening port.
   127  
   128  - ```ws.rpcprefix```: HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
   129  
   130  - ```ws.modules```: API's offered over the WS-RPC interface.
   131  
   132  - ```graphql```: Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well.
   133  
   134  ### P2P Options
   135  
   136  - ```bind```: Network binding address
   137  
   138  - ```port```: Network listening port
   139  
   140  - ```bootnodes```: Comma separated enode URLs for P2P discovery bootstrap
   141  
   142  - ```maxpeers```: "Maximum number of network peers (network disabled if set to 0)
   143  
   144  - ```maxpendpeers```: Maximum number of pending connection attempts (defaults used if set to 0)
   145  
   146  - ```nat```: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)
   147  
   148  - ```nodiscover```: "Disables the peer discovery mechanism (manual peer addition)
   149  
   150  - ```v5disc```: "Enables the experimental RLPx V5 (Topic Discovery) mechanism
   151  
   152  ### Telemetry Options
   153  
   154  - ```metrics```: Enable metrics collection and reporting.
   155  
   156  - ```metrics.expensive```: Enable expensive metrics collection and reporting.
   157  
   158  - ```metrics.influxdb```: Enable metrics export/push to an external InfluxDB database (v1).
   159  
   160  - ```metrics.influxdb.endpoint```: InfluxDB API endpoint to report metrics to.
   161  
   162  - ```metrics.influxdb.database```: InfluxDB database name to push reported metrics to.
   163  
   164  - ```metrics.influxdb.username```: Username to authorize access to the database.
   165  
   166  - ```metrics.influxdb.password```: Password to authorize access to the database.
   167  
   168  - ```metrics.influxdb.tags```: Comma-separated InfluxDB tags (key/values) attached to all measurements.
   169  
   170  - ```metrics.influxdbv2```: Enable metrics export/push to an external InfluxDB v2 database.
   171  
   172  - ```metrics.influxdb.token```: Token to authorize access to the database (v2 only).
   173  
   174  - ```metrics.influxdb.bucket```: InfluxDB bucket name to push reported metrics to (v2 only).
   175  
   176  - ```metrics.influxdb.organization```: InfluxDB organization name (v2 only).
   177  
   178  ### Account Management Options
   179  
   180  - ```unlock```: "Comma separated list of accounts to unlock.
   181  
   182  - ```password```: Password file to use for non-interactive password input.
   183  
   184  - ```allow-insecure-unlock```: Allow insecure account unlocking when account-related RPCs are exposed by http.
   185  
   186  - ```lightkdf```: Reduce key-derivation RAM & CPU usage at some expense of KDF strength.
   187  
   188  ## Usage
   189  
   190  Use multiple files to configure the client:
   191  
   192  ```
   193  $ bor server --config ./legacy-config.toml --config ./config2.hcl
   194  ```