mirror of
https://github.com/monero-project/monero-docs.git
synced 2024-10-30 19:07:35 +00:00
4.6 KiB
4.6 KiB
monerod
- reference
Syntax
./monerod [options] [command]
Options affect how daemon should be working. Commands assume the daemon is already running. Commands give access to specific services provided by the daemon.
Options
Following option groups are only to make the reference easier to follow. The daemon itself does not group options in any way.
Pick network
Option | Description |
---|---|
(missing) | By default monerod assumes mainnet. |
--stagenet |
Run on stagenet. Remember to run your wallet with --stagenet as well. |
--testnet |
Run on testnet. Remember to run your wallet with --testnet as well. |
Logging
Option | Description |
---|---|
--log-file |
Full path to the log file. Example (mind file permissions): ./monerod --log-file=/var/log/monero/mainnet/monerod.log |
--log-level |
0-4 with 0 being minimal logging and 4 being full tracing. Defaults to 0 . These are general presets and do not directly map to severity levels. For example, even with minimal 0 , you may see some most important INFO entries. Temporarily changing to 1 allows for much better understanding of how the full node operates. Example: ./monerod --log-level=1 |
--max-log-file-size |
Soft limit in bytes for the log file (=104850000 by default, which is just under 100MB). Once log file grows past that limit, monerod creates next log file with a -YYYY-MM-DD-HH-MM-SS UTC timestamp postfix. In production deployments, you would probably prefer to use established solutions like logrotate instead. |
Server
The monerod
defaults are adjusted for running it occasionally on the same computer as your Monero wallet.
The following options will be helpful if you intend to have an always running node - most likely on a remote server or your own separate PC.
Option | Description |
---|---|
--config-file |
Full path to the configuration file. By default monerod looks for bitmonero.conf in Monero data directory. TODO: describe configuration file syntax. |
--data-dir |
Full path to data directory. This is where the blockchain, log files, and p2p network memory are stored. For defaults and details see data directory. |
--pidfile |
Full path to the PID file. Works only with --detach . Example: ./monerod --detach --pidfile=/run/monero/monerod.pid |
--detach |
Go to background (decouple from the terminal). This is useful for long-running / server scenarios. Typically, you will also want to manage monerod daemon with systemd or similar. By default monerod runs in a foreground. |
--non-interactive |
Do not require tty in a foreground mode. Helpful when running in a container. By default monerod runs in a foreground and opens stdin for reading. This breaks containerization because no tty getss assigned and monerod process crashes. You can make it run in a background with --detach but this is inconvenient in a containerized environment because the canonical usage is that the container waits on the main process to exist (forking makes things more complicated). |
Help and Version
Option | Description |
---|---|
--help |
Enlists available options. |
--version |
Shows monerod version to stdout. Example: Monero 'Lithium Luna' (v0.12.3.0-release) |
TO BE CONTINUED