Permalink
Browse files

added some simple documentation

  • Loading branch information...
1 parent 1511d15 commit 8f98f4151a517c6d25f086d617ed79fe3f3d40f6 @SOELexicon committed on GitHub Dec 26, 2016
Showing with 26 additions and 0 deletions.
  1. +26 −0 README.md
View
@@ -9,3 +9,29 @@ please donate for development to
[Burst] BURST-GAJL-VWKN-2XPB-H39R9
[Bitcoin] 1EWqGpP96Jx2gnD4UQBEoMrdpJPmLpdKJH
+
+config
+"devFee" that if enabled would send [devFeePercent] of the pools earnings as a developer fee to myself after a few requests of people wanting to support the project. 1% works out to be less than 25 coins. getting lower each month.
+"devFeePercent" pool owners can choose the percent they wish to donateto development
+"blockMature" amount of blocks the pool goes back and checks for block winner
+"txFeePercent" Currently not implemented. tx fee is currently added to block reward and then a pool fee is applied to that total - 0.01 = 1%
+"poolFee" the percent a pool owner charges for hosting etc. 0.01 = 1%
+"poolPort" the port the pool is run on. default 8124
+"poolPvtKey" pool private key
+"poolPublicRS" pool public BURST- Address
+"poolPublic" Pool numerical burst address
+"poolFeePaymentAddr" where the fees for Pool Fee should get sent
+"cumulativeFundReduction" % to reserve for each prior round.
+"logWebsocketToConsole" output whats sent to peoples browsers into the console window
+"maxRoundCount" max rounds to display in all round shares. any that exceed this are deleted
+"maxRecentPaymentHistory" max lines to show in payment history
+
+
+ in the pool config.js a useful feature if you ever have to swap hosts is
+
+redirection : {
+ enabled : false,
+ target : 'http://8.8.8.8:8124'
+ },
+so change the 8.8.8.8 on the old server config to the new servers ip and enabled to true then it should forward all the requests.
+tip - make sure you also change a few characters in the old servers passphase so the pool doesnt accidentally pay out twice

0 comments on commit 8f98f41

Please sign in to comment.