IOTA IRI configuration documentation

This is a documentation of IOTA IRI configuration options. This documentation contain most of the options, except some options start with P_. Some useful options are PORT, UDP_RECEIVER_PORT, TCP_RECEIVER_PORT, NEIGHBORS. Most of the options are not used by normal users, but you still can check this list to figure what you may need.

0x1 IOTA IRI configuration documentation

IOTA IRI Configuration Listkeep this under your pillow
API_HOSTThis is the api host address, other service or user may use this address to used IOTA IRI Restful API serviceslocalhostIf you want to public your API, you can set to, otherwise localhost will limit API access to yourself
PORTThis is the port that used by IOTA IRI API (*NOT* neighbors tcp receiver port)14600This used TCP port
UDP_RECEIVER_PORTThis is the port used for UDP neighbors, you will need to give other this port number if both of you using UDP to transmit14600
TCP_RECEIVER_PORTThis is the port used for TCP neighbors, you will need to give other this port number if both of you using TCP to transmit15600
NEIGHBORSNeighbors that you are connected withRemember, neighbors will only works when both of you added each others URI, and TCP to TCP, UDP to UDP, do not mixed it!
TSETNETMakes it possible to run IRI with the IOTA testnetFALSE
DEBUGEnable IOTA IRI to print the debug informationFALSEIf you want to enable debug, you will need to modify IRI logback.xml (uncomment debug part) and recompile, repackage IRI
REMOTE_LIIMIT_APIExclude certain API calls from being able to be accessed remotelySome POW API like getTransactionToApprove, attachToTangle you may want to disable, and removeNeighbors, addNeighbors for example. For full API list, please visit:
REMOTE_AUTHRequire authentication password for accessing remotely. Requires a correct username:hashedpassword combination
IXI_DIRIRI extensions directory path, this directory used to manage IRI extensionsixiFor extensions example, please visit:
MAIN_DBIRI database provider, default using rocksdbrocksdbYou can changed this value if you add your own version of persistence provider. You can look at source code to check how it works
DB_PATHIRI database pathmainnetdb
DB_LOG_PATHIRI database log pathmainnet.log
DB_CACHE_SIZEIRI database cache size100000Using MB to count
RESCAN_DBIt will remove all address, bundle, approvee and tag in database and rescan all tx, refill the columns when restart IRIFALSE
EXPORTEnable transaction export to fileFALSE
ZMQ_ENABLEDEnable IRI ZMQFALSEFor zmq documentation, please visit:, for zmq used example, please visit:
ZMQ_PORTThis is the port used for ZMQ5556
ZMQ_IPCThis is the URI used for ZMQ IPRipc://iri
ZMQ_THREADSThis is the thread nubmer used for ZMQ threads2
MAINNET_MWMMinimum weight magnitude used in mainnet14
TESTNET_MWMMinimum weight magnitude used in testnet13
MIN_RANDOM_WALKSMinimum random walk for selecting tips5For random walk options, it is used at transactionToApprove – the step to select two tips for verification in the transaction begin. It is used as a iteration times in MCMC (Markov Chain Mote Carlo)
MAX_RANDOM_WALKSMaximum random walk for selecting tips27
MAX_DEPTHMaximum depth for selecting tips15This is used in MCMC to choose which tips CAN be select. If this value get larger, that means it can choose select more tips in the tangle (depth from latest tips)
MAX_FIND_TRANSACTIONSMaximum transactions allowed for findTransaction command100000
MAX_REQUESTS_LISTMaximum request input length1000For example, addNeighbors will use{…, uris: [tcp://…, tcp://…, udp://…]}, this is the value that limited the length of the uris
MAX_GET_TRYTESMaximum return from getTrytes command10000If the return list length is larger than MAX_GET_TRYTE, you will get error
MAX_BODY_LENGTHMaximum length of request body1000000
SOURCE: Louie Lu, IRI source code

0x2 Example IOTA IRI ini file

0x3 References

If you like this post, you can tip here:

  • BTC: 3AsymiF89R3xguzrCUjS5rPUS1KeCXrfHF
  • ETH: 0x6FAA7CEdBeDaC6edf5E218D2f95B83B34499fc6F
  • LTC: MNBTs339PLXKdv2U2Z8dpvdLBMsqATkEyR
  • LTC(ddeprecated): 3FyKZ9dBSDftqQkZvg9J1HNvrfHP89PJFk
  • DASH: XehuTHVnBfF6dqRYQfA9SV9oYyFhrNxiyW
  • BCH: 12YGnthT4RSUW6a4WDivDp9rLogGkcpcCP


BTH: 35QooNA82isrmQLmpEnqXpJoxeZmaPubPf



2 comments On IOTA IRI configuration documentation

Leave a reply:

Your email address will not be published.

這個網站採用 Akismet 服務減少垃圾留言。進一步了解 Akismet 如何處理網站訪客的留言資料