Creating example gridcoinresearch.conf

ghost commented 6 years ago

I have tried to Create a example gridcoinresearch.conf as asked for in #https://github.com/gridcoin/Gridcoin-Research/issues/903 Need Feedback where it can be Improved and help with the Explanations https://gist.github.com/Toggleton/c8bb9a820f1efdec5be4a6a002273d35

Reference: https://github.com/bitcoin/bitcoin/blob/master/contrib/debian/examples/bitcoin.conf

G-UK commented 6 years ago

Good Job, just a few comments and tweaks.

I would keep the basic Required options at the top.
CPID & Investor not technically required as Investor but it is good to have them as standard in the conf.
listen=1 again isn't techincally required but I would put it in as required as it is highly recommended.
Moved the RPC stuff together and marked it as required for Linux users.

Production Wallet

#############################################################################
#################### Example gridcoinresearch.conf file #####################
#############################################################################
##
## For further details on this configuration file please see:
## http://wiki.gridcoin.us/Gridcoinresearch_config_file
##
## Default gridcoinresearch.conf location:
##
##  Win:   %AppData%\GridcoinResearch\
##  Linux: ~/.GridcoinResearch/
##  MacOS: /Users/USERNAME/Library/Application/Support/GridcoinResearch/
##
## Single # lines are commands, remove the # in Front of the Command to use it
## Double ## lines are comments
##
#############################################################################
####################### Required Settings (All OS's) ########################
#############################################################################

## Community provided list of addnodes available at
## http://wiki.gridcoin.us/List_of_Addnodes
#~~~~~Copy & Paste Addnodes here~~~~~

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

## BOINC account settings, i.e. your BOINC CPID & E-Mail
## Use INVESTOR for Investor or Pool Mining
PrimaryCPID=INVESTOR
email=INVESTOR

## Port 32749/TCP required for Inbound Connections
## (Not required but highly recommended)
listen=1

## Required for Headless set-ups
#daemon=1

#############################################################################
############# RPC Settings for Remote Access and Headless Users #############
############ Warning: Set a Good Password and Secure Your System ############
#############################################################################

#server=1
#rpcallowip=127.0.0.1
#rpcallowip=<IP Address of Remote System>
#rpcport=<Port for RPC Communication>
#rpcuser=<A Username for RPC>
#rpcpassword=<A GOOD Password for RPC>

#############################################################################
######################## Optional BOINC settings ############################
########### (Required if BOINC installed to non-default location) ###########
#############################################################################

## Windows (Note the double backslashes are neccessary)
#boincdatadir=C:\\ProgramData\\BOINC\\
#boincappdir=C:\\Program Files\\BOINC\\ 

## Linux
#boincdatadir=/var/lib/boinc-client/

## MacOS
#boincdatadir=/Library/Application Support/BOINC Data/

#############################################################################
######################## Optional Network settings ##########################
#############################################################################

## Maximum number of inbound+outbound connections.Default 125
maxconnections=125
## Maximum number of outbound connections.Default 8
maxoutboundconnections=8
## Manually Set-up Ports
#upnp=false
#externalip=<Your IP Address>
#port=32749

Testnet Wallet


#############################################################################
#################### TESTNET gridcoinresearch.conf file #####################
################## THIS FILE IS ONLY FOR USE ON THE TESTNET #################
######################### DO NOT USE ON PRODUCTION ##########################
#############################################################################
##
## TESTNET USERS MUST LAUNCH THE WALLET USING THE -testnet FLAG
## TESTNET USERS MUST JOIN THE #Testnet CHANNEL ON Slack
##
## For further details on this configuration file please see:
## http://wiki.gridcoin.us/Gridcoinresearch_config_file
##
## Default testnet gridcoinresearch.conf location:
## 
##  Windows: %AppData%\GridcoinResearch\testnet\
##  Linux:   ~/.GridcoinResearch/testnet/
##  MacOS:   /Users/USERNAME/Library/Application/Support/GridcoinResearch/testnet/
##
## Single # lines are commands, remove the # in Front of the Command to use it
## Double ## lines are comments
##
#############################################################################
####################### Required Settings (All OS's) ########################
#############################################################################

## You must set your username to assist developers tracking down problems
org=CHANGE_ME_OR_FACE_THE_WRATH_OF_BARTON

## Decrease ban expiration time. The default 24 hours is too long for testnet.
## Nodes are banned for sending bad data (seconds)
bantime=60

## These Addnodes are for TESTNET only. See Slack for further details.
addnode=vancouver01.gridcoin.ifoggz-network.xyz
addnode=toronto01.gridcoin.ifoggz-network.xyz
addnode=test.grcpool.com
addnode=testnet.grcnode.co.uk 
addnode=testnet.dihelix.com
addnode=ormgas.com

## BOINC account settings, i.e. your BOINC CPID & E-Mail
## Use INVESTOR for Investor or Pool Mining
PrimaryCPID=INVESTOR
email=INVESTOR

## Port 32748/TCP required for Inbound Connections
## (Not required but highly recommended)
listen=1

## Required for Headless set-ups
#daemon=1

#############################################################################
############# RPC Settings for Remote Access and Headless Users #############
############ Warning: Set a Good Password and Secure Your System ############
#############################################################################

#server=1
#rpcallowip=127.0.0.1
#rpcallowip=<IP Address of Remote System>
#rpcport=<Port for RPC Communication>
#rpcuser=<A Username for RPC>
#rpcpassword=<A GOOD Password for RPC>

#############################################################################
######################## Optional BOINC settings ############################
########### (Required if BOINC installed to non-default location) ###########
#############################################################################

## Windows (Note the double backslashes are neccessary)
#boincdatadir=C:\\ProgramData\\BOINC\\
#boincappdir=C:\\Program Files\\BOINC\\ 

## Linux
#boincdatadir=/var/lib/boinc-client/

## MacOS
#boincdatadir=/Library/Application Support/BOINC Data/

#############################################################################
######################## Optional Network settings ##########################
#############################################################################

## Maximum number of inbound+outbound connections.Default 125
maxconnections=125
## Maximum number of outbound connections.Default 8
maxoutboundconnections=8
## Manually Set-up Ports
#upnp=false
#externalip=<Your IP Address>
#port=32748

ghost commented 6 years ago

Do we need to add a publickey & privatekey part and a Warning to not post your keys?(its long ago since i done that .. not sure the Explanation is true) --------Edit 21.1.2018-------- ##When you advertise your Beacon ##your private and public keys will be added to the bottom of the file ##!Warning! Keep your Keys privat)

tomasbrod commented 6 years ago

email= needs to be set in order to earn DPoR and get beacon.

server=1 is not required unless you want to control the wallet using rpc. In fact, you should NOT set it unless you have properly SECURED your setup (folder permissions, firewalls, password, disable guest account...)

daemon=1 is not required for Linux users. It is certainly useful for some legacy setups.

boincdatadir for Arch Linux is /var/lib/boinc/. But you can disregard this complaint as they are smart enough to figure this out.

PrimaryCPID is optional. Set it only if you have split CPID. It may not even have a effect.

testnet=1 MUST be supplied on command line as -testnet. Specifying it only in config has unexpected behaviour.

G-UK commented 6 years ago

server=1 So this would only be set for a headless Linux set-up? daemon=1 Is there a downside to having this set on Linux? If not it probably should just be set anyway for simplicity for new users. PrimaryCPID Again is there a downside to having this set? If not it probably should just be set anyway for simplicity for new users.

tomasbrod commented 6 years ago

# Set this to 1 to enable remote control of wallet using RPC
# set a good rpcpassword and secure your system if you do
server=0

tomasbrod commented 6 years ago

# Decrease ban expiration time. The default 24 hour expiration
# is too long for use in testnet. Nodes are banned for sending
# bad data, which happens often while testing. (seconds)
bantime=60

RoboticMind commented 6 years ago

Can this be closed now?

tomasbrod commented 6 years ago

Is the result published somewhere? Wiki or even better the repo (gridcoinresearch.conf.example).?

ghost commented 6 years ago

http://wiki.gridcoin.us/Gridcoinresearch_config_file Does it make sense to add it to the Wallet repo in the“contrib“,“doc“ folder or so

gridcoin-community / Gridcoin-Tasks

Creating example gridcoinresearch.conf #204

Production Wallet

Testnet Wallet