Difference between revisions of "PyBitmessage Help"

From Bitmessage Wiki
Jump to navigation Jump to search
(→‎Configuration: added "max acceptable difficulty" tab.)
Line 78: Line 78:
  
 
== Database cleanup ==
 
== Database cleanup ==
The database ([[messages.dat]]) can be cleaned and shrinked manually with the menu '''File > Delete all trashed messages'''
+
The database ([[messages.dat]]) can be cleaned and shrinked manually with the menu '''File > Delete all trashed messages'''.
 
The database is compacted once every month automatically without deletation of trashed messages.
 
The database is compacted once every month automatically without deletation of trashed messages.
  

Revision as of 23:24, 15 June 2013

Welcome to the help page for PyBitmessage.

Clarification

PyBitmessage is the official client, used as protocol reference. It is usually abbreviated "Bitmessage", causing confusion between the protocol and the client.

Initial setup

PyBitmessage can be downloaded from the Main Page, either as Windows binary or as source from github. Other builds (for example for Mac OS X) can be found in the forum. The client sets up itself completely automatic. It can be launched and the required files for its operation are created if they do not exist.

Daily usage

Main window with sent tab open

PyBitmessage will automatically connect to other clients on start up, the user does not needs to wait for this to complete and can instantly send messages. POW can be made if offline. The Main interface contains the folowing tabs:

Inbox

The inbox contains all your received messages (top part) and displays the currently selected message (bottom part). The bottom window allows copying and editing the message but it will not be saved. The context menu in the message list provides additional features, such as HTML view or reply option. Using the HTML view renders some HTML tags from the message, for example images. Messages that are no longer needed can be sent to the trash with the [DEL] key.

Send

The "Send" tab is used to compose new private or Broadcast messages. A message can be dedicated to multiple people but the protocol supports only one receiving address per message. Example: Sending a message to 8 people will generate the exact same message 8 times in the "Sent" tab.

Sent

The sent tab displays messages sent by the user, including messages that are in the process of proof of work. The status column displays the current status of the message. Table with the most common messages:

Status Description
Doing work necessary to send <type>... POW is being done
<type> sent on <date/time> The message has been sent
Waiting on Acknowledgement The message has been sent but the receiver has not received it yet. Not applicable for broadcasts
Acknowledgement received on <date+time> The receiver got the message. Not applicable for broadcasts

Messages can be sent to the trash with the [DEL] key however, this will not stop POW from being made if it has already started.

Your Identities

Contains a list of all addresses stored in keys.dat and allows to generate new ones. The context menu allows to enable/disable addresses. Addresses can be labeled, this label is then displayed instead of the address. Labels are not sent over the network and are only visible to the client. Addresses cannot be deleted directly in this tab, but removing the Address Block from keys.dat removes it. Editing the keys.dat file requires the user to shut down the client first.

Subscriptions

Contains a list of all broadcasts, that the client will receive. To receive broadcasts its address must be added first to the list. The context menu allows enabling/disabling of addresses. Addresses can be deleted with the [DEL] key.

Address Book

Can be used to associate addresses with labels for easier recognition.

Blacklist/Whitelist

Addresses can be blacklisted or whitelisted. The Operation mode of the list (whitelist or blacklist) ban be set too. The context menu allows entries to be enabled and disabled. Entries can be deleted with the [DEL] key.

Network Status

Shows the Stream number and the number of connected nodes in a list. Displays when it was started and how much information has been processed yet.

Configuration

Bitmessage can be configured by editing keys.dat or by using the menu Settings > Settings in the GUI.

Settings Menu

The settings menu has the folowing tabs:

User Interface

Allows customization how bitmessage is started and if it should run in portable mode or not.

Network Settings

Allows setting of the TCP port used for incomming connections. This can be left at default value for most users. A proxy server can be defined if the user wishes to do so. Supports SOCKS4a and SOCKS5 with Authentication support.

Demanded Difficulty

The demanded difficulty allows to increase the amount of POW to be done for other clients to send messages to the user. POW for users in the address book is always 1. Doubling the number doubles the amount of time required.

Max acceptable difficulty

Similar to the "demanded difficulty" tab, this tab has the exact same textboxes, however, they are used to limit the amount of POW the user is willing to do. If he sends a message and the destination address wants him to do more POW than he set as maximum, the message will not be processed. The user can click with the right mouse button on the message and force it to be sent or he can delete the message.

Database cleanup

The database (messages.dat) can be cleaned and shrinked manually with the menu File > Delete all trashed messages. The database is compacted once every month automatically without deletation of trashed messages.

Statistics

Time

On an average computer, different processes take different amounts of time.

Action Time required
Sender generate a public key request 2 minutes
public key request propagate through the network to the receiver 10 seconds
Receiver reply to the first public key request they receive 2 minutes
Receiver reply to subsequent public key requests they receive 5 seconds
Sender do work necessary to send message 4 minutes
message (or acknowledgement data) propagate through the network 10 seconds