Difference between revisions of "Keys.dat options"

From Bitmessage Wiki
Jump to navigation Jump to search
(added table.)
Line 1: Line 1:
This page lists the extra 'hidden' options of which you can make use by adding them to your keys.dat file.  
+
This page lists the extra 'hidden' options of which you can make use by adding them to your [[keys.dat]] file in the bitmessagesettings section. These options are either not set by default or are not documented at all.
  
 +
<!--
 +
Copy these two lines for easy expansion of the table
  
Option: trustedpeer
+
|-
 +
| VERSION || NAME || VALUE || WIKIPAGE || DESCRIPTION
 +
-->
  
Explanation: Connect to the specified node and only the specified node. Useful if you trust a node on your local network and want to sync to it quickly. Disallows incoming connections. Disables the built-in timing attack mitigation mechanism. You must use an IP, using hostnames is not supported.
+
== Possible options ==
  
Example: trustedpeer = 12.34.56.78:8444
+
{|class="wikitable"
 +
! Version !! Name !! Values !! Documentation !! Description
 +
|-
 +
| ? || trustedpeer || IP:Port || undocumented || Connect to the specified node and only the specified node. Useful if you trust a node on your local network and want to sync to it quickly. Disallows incoming connections. Disables the built-in timing attack mitigation mechanism.
 +
|-
 +
| 0.2.7 || apienabled || true/false || [[API|API Reference]] || Turns the [[API]] on or off
 +
|-
 +
| 0.2.7 || apiport || number || [[API|API Reference]] || Port number to listen on (0-65535)
 +
|-
 +
| 0.2.7 || apiinterface || IP || [[API|API Reference]] || IP address of a local interface. 127.0.0.1 for localhost only access and 0.0.0.0 for all interfaces.
 +
|-
 +
| 0.2.7 || apiusername || string || [[API|API Reference]] || Username to access the API
 +
|-
 +
| 0.2.7 || apipassword || string || [[API|API Reference]] || password to access the API
 +
|}
  
 
+
== enabling options ==
(this page is lacking the rest of the options.. there are more)
+
To enable an option, the [[keys.dat]] must be edited.
 +
Lines of the format
 +
<pre>name = Value</pre>
 +
can be added. '''Please be aware of the spacing around the equal sign'''

Revision as of 23:25, 2 May 2014

This page lists the extra 'hidden' options of which you can make use by adding them to your keys.dat file in the bitmessagesettings section. These options are either not set by default or are not documented at all.


Possible options

Version Name Values Documentation Description
? trustedpeer IP:Port undocumented Connect to the specified node and only the specified node. Useful if you trust a node on your local network and want to sync to it quickly. Disallows incoming connections. Disables the built-in timing attack mitigation mechanism.
0.2.7 apienabled true/false API Reference Turns the API on or off
0.2.7 apiport number API Reference Port number to listen on (0-65535)
0.2.7 apiinterface IP API Reference IP address of a local interface. 127.0.0.1 for localhost only access and 0.0.0.0 for all interfaces.
0.2.7 apiusername string API Reference Username to access the API
0.2.7 apipassword string API Reference password to access the API

enabling options

To enable an option, the keys.dat must be edited. Lines of the format

name = Value

can be added. Please be aware of the spacing around the equal sign