diff --git a/README.md b/README.md index d3b1b2a..ce92889 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,12 @@ docker run -d --name=flosight \ docker logs -f flosight ``` + +Open the page http://localhost:8080/api/sync to view the sync status (available API endpoints). After sync is at 100%, you can open the page http://localhost:8080. If you open the homepage while it is still syncing, you will quickly get rate limited, as the UI makes a request for every block update that comes in (this is a bug that may be fixed at some point in the future). + +## Environment Variables +Flo Explorer uses Environment Variables to allow for configuration settings. You set the Env Variables in your docker run startup command. Here are the config settings offered by this image. + +NETWORK: [mainnet|testnet] The Flo network you wish to run the Flo Explorer on (Default mainnet). +ADDNODE: [ip-address] An IP address of a Flo node to be used as a source of blocks. This is useful if you are running isolated networks, or if you are having a hard time connecting to the network. +CUSTOM_FCOIN_CONFIG: [String] A string (seperated with \n to split lines lines) of extra config variables to add to fcoin.conf (fcoin is the internal Flo Fullnode for the Flo Explorer)