Update README.md

This commit is contained in:
Vivek Teega 2023-02-16 18:18:31 +05:30 committed by GitHub
parent 6c800d8fc1
commit 81e3490138
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,6 +9,16 @@ docker volume create flosight
docker run -d --name=flosight -p 9200:80 --mount source=flosight,target=/data --env NETWORK=mainnet --env ADDNODE=ramanujam.ranchimall.net --env BLOCKCHAIN_BOOTSTRAP=https://bootstrap.ranchimall.net/flosight1.tar.gz ranchimallfze/flosight:github
docker logs --follow --tail 500 flosight
# If you want flosight to automatically start after your server/computer restarts, then add restart policy
# --restart=always
docker run -d --restart=always --name=flosight -p 9200:80 --mount source=flosight,target=/data --env NETWORK=mainnet --env ADDNODE=ramanujam.ranchimall.net --env BLOCKCHAIN_BOOTSTRAP=https://bootstrap.ranchimall.net/flosight1.tar.gz ranchimallfze/flosight:github
# If you want to change the restart policy of an existing container
docker update --restart=always <container>
```
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).
@ -16,9 +26,9 @@ Open the page http://localhost:8080/api/sync to view the sync status (available
## 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)
* 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)
## Instructions to build the image