Bitmessage Wiki - User contributions [en]

Compiling instructions

2014-02-01T20:52:30Z

Mtkfm: Formatting

This page should help novice users run Bitmessage from the source code files.

= Linux =

== Resolve dependencies ==
{| class="wikitable" border="1" width="80%"
|-
! Distribuion
! Instructions
|-
! scope="row"| Debian-based
(Ubuntu, Raspbian, PiBang, others)
| ''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems]. Debian 7 "wheezy" works without problems.''
sudo apt-get install python openssl git python-qt4
|-
! scope="row"| Arch Linux
|
sudo pacman -S python2 openssl git python2-pyqt4
|-
! scope="row"| Fedora
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install -y http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
su -c 'yum install -y python python-qt4 git openssl-compat-bitcoin-libs'

Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bashrc && source ~/.bashrc
|-
! scope="row"| Red Hat Enterprise Linux (RHEL)
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install -y http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
su -c 'yum install -y python python-qt4 git openssl-compat-bitcoin-libs'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bashrc && source ~/.bashrc
|}

== Download and run PyBitmessage ==
# Download the source code from github: <code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>
# Run PyBitmessage: <code>~/PyBitmessage/src/bitmessagemain.py</code>
Check the wiki for more information on how to run Bitmessage [https://bitmessage.org/wiki/Daemon as a daemon].

If you receive a warning that you need to use python 2.7.5 or greater, and have followed the above instructions to upgrade it, your system may be attemping to run PyBitmessage with python 3. In this case, run <code>python2 ~/PyBitmessage/src/bitmessagemain.py</code>

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

; Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
Read the instructions or take this as a reminder: Apple's XCode and their Command Line Tools are a prerequiste for Macports, go: https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.5 from [http://www.python.org/download/releases/2.7.5/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
## Test that it installed:
### Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
### type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
### If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
#### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
#### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
#### Close the command prompt window and reopen it.
### Try running 'python' again.
###Press Ctrl-Z to exit Python.
# Download PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. ''PyQt is one of Bitmessage's two dependencies.'' Look for the links to downloads under the heading labeled "Binary Package;" the binary package versions are already compiled for you. Select the version for Python 2.7 (look for "Py2.7" in the file name). Install PyQt.
# Download OpenSSL from [http://slproweb.com/products/Win32OpenSSL.html here]. ''OpenSSL is the second of Bitmessage's two dependencies.'' Install OpenSSL. If an error message appears during installation of OpenSSL, download and install Visual C++ 2008. A link is provided on the OpenSSL download page.
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Optionally also include the translations by modifying this file further by adding the lines shown in [[Example_pyinstaller_spec_file|this]] example file.
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

FAQ

2013-10-12T02:48:12Z

Mtkfm: /* How does Bitmessage compare to other messaging methods */ XMPP + OTR

==Installation and configuration==
===How do I install Bitmessage===
Bitmessage does not needs to be "installed". it is simply downloaded and executed. You can find instructions to download and run bitmessage from the [[Main Page]].
A great write up for setting up and using Bitmessage on Windows can be found [http://cryptojunky.com/blog/2013/03/09/setting-up-and-using-bitmessage-an-encrypted-communications-platform-based-on-bitcoin/ Here.]

Bitmessage should run on any OS though it is only lightly tested on OSX. The start-on-boot and minimize-to-tray features are only implemented for Windows thus far. Several examples of how to install Bitmessage on *nix and OSX platforms can be found [https://bitmessage.org/forum/index.php in the forums.]

===How do I become a node to help the network===
If your connection indicator is green then you are already accepting incoming connections and helping the Bitmessage network.

If your connection indicator is yellow, check your firewall settings and port forwarding to make sure incoming connections are allowed to your machine on the correct TCP port (Default: 8444), the port can be found in the Bitmessage settings.

You can click on the indicator for more information about each color.

===Why is my Connection Indicator Yellow===
Bitmessage will work normally with a yellow indicator. If your indicator is yellow, you can have up to 8 connections. To make your indicator green, please forward the required TCP port (usually 8444). You can find the Port in the Bitmessage settings.

===How do I setup Bitmessage to work with Tor===

'''Tor'''

If you are using the Tor Browser Bundle skip to the next section. In order for Bitmessage to use Tor as a proxy follow these steps.
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9050'.
*Select ok.
*Restart Bitmessage.

'''Tor Browser Bundle'''
*Navigate to Settings > Network Settings and select SOCKS5 from the Type: drop down under the Proxy server / Tor section.
*Next to 'Server hostname:' enter 'localhost' and next to 'Port:' enter '9150'.
*Select ok.
*Restart Bitmessage.

==Usage==
===How can I run Bitmessage in daemon mode===
Refer to the [[Daemon|Daemon Mode Page]].

===How many connections should I have===
As long as you have at least one connection, you can communicate with the network. If your connection indicator is yellow, you can have a maximum of 8 connections.

===Can I send a message to someone that is offline===
Yes. However, if you go offline then they must come back online within 2 days of the message being sent. Nodes delete data, and do not accept data, older than 2 days.

===How do I format my messages===
Here is [https://qt-project.org/doc/qt-4.8/richtext-html-subset.html the list of supported HTML tags].

===What are subscriptions?===

A [[Subscriptions|subscription]] allows you to receive messages, that were broadcasted by the address you subscribe too.
Since [[broadcast]] messages are encrypted with a key, that can be created by everyone who knows the address, you must be subscribed to an address to actually read the messages.

Subscriptions are also required to use a [[Mailing List]].

===What are "chans"?===
Chan is another word for DML. Please refer to [[DML|this article]] for a complete documentation of this rather complex feature.

==How does Bitmessage work==
'''Startup'''

When you first start Bitmessage, your client connects itself to the network and starts downloading a list of known nodes. Each new node that you connect to shares its list of known nodes. In addition to the known nodes, you will also start receiving person-to-person messages, broadcasts, and public keys. If any of these messages are bound for you, they will be shown in your inbox. All of this data is exchanged between all of your connections to make sure that everyone has a copy.

'''Sending a Message'''

When you send a message, your client must first compute a Proof of Work (POW). This POW helps mitigate spam on the network. Nodes and other clients will not process your message if it does not show sufficient POW. After the POW is complete, your message is shared to all of your connections which in turn share it with all of their connections.

===Where can I find more documentation about Bitmessage===
* [https://bitmessage.org/bitmessage.pdf Overview White Paper (PDF)]
* [[Protocol specification]]
* Detail about the [[Proof of work]]

==How does Bitmessage compare to other messaging methods==
Here is a table comparing Bitmessage to other common messaging services.

{| border="1" class="wikitable"
|+ Comparison of Messaging Services
!  
! Trustless
! P2P
! Open Source
! Requires Proof of Work
! Hide Sender?
! Hide Receiver?
! Mobile Version
! Application or Web Based
! Text Only Messages
! Attachments
! Acknowledge delivery
|-
! Bitmessage
| Yes
| Yes
| [http://opensource.org/licenses/mit-license.php MIT]
| Yes
| Yes
| Yes
| No
| Application
| No
| Small only
| Yes
|-
! Standard Email
|
| No
| Depends
| No
| No
| No
| Yes
| Both
| No
| Yes
| No
|-
! Email + GPG
| Yes
| No
| Depends
| No
| No
| No
| Yes
| Application
| Yes
| No
| No
|-
! [http://xmpp.org/ XMPP] + [https://en.wikipedia.org/wiki/Off-the-Record_Messaging OTR]
| Yes
| No
| GPL V2.1
| No
| No
| No
| Yes
| Application
| Yes
| No
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
| Yes
| Yes
| GPL
| No
| Yes
| Yes
| No
| Application
| Yes
| Yes
|
|-
! [http://www.skype.com/en/ Skype]
| No
| No
| No
| No
| No
| No
| Yes
| Application
| No
| Yes
|
|-
! [http://www.scayl.com/ Scayl]
| No
| Yes
| No
| No
| No
| No
| Alpha
| Application
| No
| Very Large
|
|-
! [https://en.wikipedia.org/wiki/I2P#E-mail I2P Bote]
| Yes
| Yes
| GPL V3
| No
| Yes
| No
| No
| Application
| Yes
| Yes
| Yes
|-
! [https://crypto.cat/ CryptoCat]
| No
| No
| GPL
| No
| No
| No
| Yes
| Both
| Yes
| No
|
|-
! [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC]
|
| No
| Yes
| No
| No
| No
| Yes
| Both
| Yes
| No
|
|-
! SMS
|
| No
| No
| No
| No
| No
| Yes
| Application
| No
| Yes
| No
|-
! [http://retroshare.sourceforge.net/ RetroShare]
| No
| Yes
|
| No
| No
| No
|
|
|
| Yes
|
|-
! [https://en.wikipedia.org/wiki/Freenet#Tools_and_applications Freenet + Frost]
| Yes
| Yes
| GPL
| No
| Yes
| Yes
| No
| Application
| Yes
| Yes
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + FMS]
| No
| Yes
|
| No
| No
| Yes
| No
| Application
| Yes
| No
|
|-
! [https://mirror4.freenetproject.org/tools.html Freenet + Freemail] 0.2
| No
| Yes
| GPL
| No
| No
| No
| No
| Application
| No
| Yes
| No
|-
! [https://wiki.freenetproject.org/FLIP Freenet + FLIP]
| Yes
| Yes
|
| No
| No
| No
| No
| Application
| Yes
| No
|
|-
! [https://en.wikipedia.org/wiki/TorChat TorChat]
|
| Yes
|
| No
| Via Tor
| Via Tor
|
| Application
|
| Yes
|
|}

==Troubleshooting==
===My Connection Indicator is Red===
Check your connection settings.
Check if you can access the internet. In case you have a firewall with outgoing restrictions (not Windoes firewall) allow unrestricted access for Bitmessage through your firewall.
Sometimes Bitmessage takes time to connect to the network, especially if [[knownnodes.dat]] is large. Please allow at least 30 minutes for it to connect before posting to the forum.
You can also try deleting [[knownnodes.dat]].

If none of that works, [https://bitmessage.org/forum/index.php please visit the forum here.]

===I have not received a reply from the Echo Server===
*Your connection indicator should be yellow or green.
*Make sure that your POW is complete and the message has been sent. You should see an acknowledgement under "Status" on the "Sent" tab.
*On average it should take 8 minutes from the time you click the send button to the time you receive a response.
*Be sure to allow extra time in the event that the server is under heavy traffic (Example: An article about Bitmessage was posted on a popular website).
*You can always send a message to another echo server. Here are two echo addresses:
** BM-orkCbppXWSqPpAxnz6jnfTZ2djb5pJKDb
** BM-omXeTjutKWmYgQJjmoZjAG3u3NmaLEdZK
*You may subscribe to the [[Timeservice Broadcast]] to receive network heartbeats.
*You can send messages to a [[Mailing List]] in case it still does not works
If you still do not receive a response, [https://bitmessage.org/forum/index.php visit the forum] to see if there is a current technical issue or to submit a new request for assistance.

===Other===
Here is a list of average times for different parts of Bitmessage. [[PyBitmessage Help]]

Please [https://bitmessage.org/forum/index.php visit the forum] for all other issues.

Compiling instructions

2013-08-27T13:54:55Z

Mtkfm: /* Resolve dependencies */ Corrections: .bashrc instead of .bash_profile

This page should help novice users run Bitmessage from the source code files.

= Linux =

== Resolve dependencies ==
{| class="wikitable" border="1" width="80%"
|-
! Distribuion
! Instructions
|-
! scope="row"| Debian-based (Debian, Ubuntu, Whonix, Raspbian, PiBang, others)
| ''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems]. Debian 7 "wheezy" works without problems.''
sudo apt-get install python openssl git python-qt4
|-
! scope="row"| Arch Linux
|
sudo pacman -S python2 openssl git python2-pyqt4
|-
! scope="row"| Fedora
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install -y http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
su -c 'yum install -y python python-qt4 git openssl-compat-bitcoin-libs'

Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bashrc && source ~/.bashrc
|-
! scope="row"| Red Hat Enterprise Linux (RHEL)
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install -y http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
su -c 'yum install -y python python-qt4 git openssl-compat-bitcoin-libs'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bashrc && source ~/.bashrc
|}

== Download and run PyBitmessage ==
Download the source code from github:
<code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>

Run PyBitmessage:
<code>~/PyBitmessage/src/bitmessagemain.py</code>

Check the wiki for [https://bitmessage.org/wiki/Daemon more information] on how to run Bitmessage as a daemon.

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-27T13:30:40Z

Mtkfm: /* Resolve dependencies */ Missing backslash

This page should help novice users run Bitmessage from the source code files.

= Linux =

== Resolve dependencies ==
{| class="wikitable" border="1" width="80%"
|-
! Distribuion
! Instructions
|-
! scope="row"| Debian-based (Debian, Ubuntu, Whonix, Raspbian, PiBang, others)
| ''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems]. Debian 7 "wheezy" works without problems.''
sudo apt-get install python openssl git python-qt4
|-
! scope="row"| Arch Linux
|
sudo pacman -S python2 openssl git python2-pyqt4
|-
! scope="row"| Fedora
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs \ http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|-
! scope="row"| Red Hat Enterprise Linux (RHEL)
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs \ http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|}

== Download and run PyBitmessage ==
Download the source code from github:
<code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>

Run PyBitmessage:
<code>~/PyBitmessage/src/bitmessagemain.py</code>

Check the wiki for [https://bitmessage.org/wiki/Daemon more information] on how to run Bitmessage as a daemon.

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-23T16:00:43Z

Mtkfm: distributions bold

This page should help novice users run Bitmessage from the source code files.

= Linux =

== Resolve dependencies ==
{| class="wikitable" border="1" width="80%"
|-
! Distribuion
! Instructions
|-
! scope="row"| Debian-based (Debian, Ubuntu, Whonix, Raspbian, PiBang, others)
| ''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems]. Debian 7 "wheezy" works without problems.''
sudo apt-get install python openssl git python-qt4
|-
! scope="row"| Arch Linux
|
sudo pacman -S python2 openssl git python2-pyqt4
|-
! scope="row"| Fedora
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|-
! scope="row"| Red Hat Enterprise Linux (RHEL)
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|}

== Download and run PyBitmessage ==
Download the source code from github:
<code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>

Run PyBitmessage:
<code>~/PyBitmessage/src/bitmessagemain.py</code>

Check the wiki for [https://bitmessage.org/wiki/Daemon more information] on how to run Bitmessage as a daemon.

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-23T15:57:23Z

Mtkfm: Table was too big

This page should help novice users run Bitmessage from the source code files.

= Linux =

== Resolve dependencies ==
{| class="wikitable" border="1" width="80%"
|-
! Distribuion
! Instructions
|-
| Debian-based (Debian, Ubuntu, Whonix, Raspbian, PiBang)
| ''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems]. Debian 7 "wheezy" works without problems.''
sudo apt-get install python openssl git python-qt4
|-
| Arch Linux
|
sudo pacman -S python2 openssl git python2-pyqt4
|-
| Fedora
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|-
| Red Hat Enterprise Linux (RHEL)
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
Tell your system where to look for the library:
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|}

== Download and run PyBitmessage ==
Download the source code from github:
<code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>

Run PyBitmessage:
<code>~/PyBitmessage/src/bitmessagemain.py</code>

Check the wiki for [https://bitmessage.org/wiki/Daemon more information] on how to run Bitmessage as a daemon.

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-22T18:18:20Z

Mtkfm: Table for better readability

This page should help novice users run Bitmessage from the source code files.

= Linux =

== Resolve dependencies ==
{| class="wikitable" border="1"
|-
! Distribuion
! Instructions
|-
| Debian-based (Debian, Ubuntu, Whonix, Raspbian, PiBang)
| ''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems]. Debian 7 "wheezy" works without problems.''
sudo apt-get install python openssl git python-qt4
|-
| Arch Linux
|
sudo pacman -S python2 openssl git python2-pyqt4
|-
| Fedora
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|-
| Red Hat Enterprise Linux (RHEL)
| ''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile
|}

== Download and run PyBitmessage ==
Download the source code from github:
<code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>

Run PyBitmessage:
<code>~/PyBitmessage/src/bitmessagemain.py</code>

Check the wiki for [https://bitmessage.org/wiki/Daemon more information] on how to run Bitmessage as a daemon.

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-22T17:39:28Z

Mtkfm:

This page should help novice users run Bitmessage from the source code files.

= Linux =

''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems].''

== Resolve dependencies ==
* Debian-based distributions (Debian, Ubuntu, Whonix, Raspbian, PiBang):
:: <code>sudo apt-get install python openssl git python-qt4</code>

* Arch Linux:
:: <code>sudo pacman -S python2 openssl git python2-pyqt4</code>

* Fedora:
::''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

:: <code>su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
:: echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile</code>

* Red Hat Enterprise Linux (RHEL):
::''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

:: <code>su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
:: echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile</code>

== Download PyBitmessage ==
<code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>

== Run PyBitmessage ==
<code>~/PyBitmessage/src/bitmessagemain.py</code>

== Upgrading ==
To upgrade Bitmessage run the following commands:
:<code>cd $HOME/PyBitmessage</code>
:<code>git pull</code>

== Daemon mode ==
Check the wiki for [https://bitmessage.org/wiki/Daemon more information] on how to run Bitmessage as a daemon.

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-22T17:38:28Z

Mtkfm: Better instructions for Linux. Incorported Fedora + RHEL instructions

This page should help novice users run Bitmessage from the source code files.

= Linux =

''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems].''

== Resolve dependencies ==
* Debian-based distributions (Debian, Ubuntu, Whonix, Raspbian, PiBang):
:: <code>sudo apt-get install python openssl git python-qt4</code>

* Arch Linux:
:: <code>sudo pacman -S python2 openssl git python2-pyqt4</code>

* Fedora:
::''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

:: <code>su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
:: echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile</code>

* Red Hat Enterprise Linux (RHEL):
::''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

:: <code>su -c 'yum install python git openssl-compat-bitcoin-libs http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
:: echo 'LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/"' >> ~/.bash_profile && source ~/.bash_profile</code>

== Download PyBitmessage ==
<code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki></code>

== Run PyBitmessage ==
<code>~/PyBitmessage/src/bitmessagemain.py</code>

== Upgrading ==
To upgrade Bitmessage run the following commands:
<code>cd $HOME/PyBitmessage</code>
<code>git pull</code>

=== Daemon mode ===
: Check the wiki for [https://bitmessage.org/wiki/Daemon more information] on how to run Bitmessage as a daemon.

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-22T17:05:42Z

Mtkfm: /* Other Distributions */

This page should help novice users run Bitmessage from the source code files.

= Linux =
== Fedora + RHEL ==
'''Install dependencies:'''

''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

Repository for Fedora:
su -c 'yum install http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
or this one for RedHat Enterprise Linux (RHEL):
su -c 'yum install http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
Install dependencies:
su -c 'yum install python git openssl-compat-bitcoin-libs'
'''Download''' Bitmessage from GIT:
git clone https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage
'''Run''' Bitmessage:
cd $HOME/PyBitmessage/src/ && LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/" python bitmessagemain.py

== Other Distributions ==

''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems].''

; Resolve dependencies:
: Debian-based distributions (Debian, Ubuntu, Whonix, Raspbian, PiBang): <code>sudo apt-get install python openssl git python-qt4</code>
: Arch Linux: <code>sudo pacman -S python2 openssl git python2-pyqt4</code>

; Download and run Bitmessage:
git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki>
~/PyBitmessage/src/bitmessagemain.py

; You can also run Bitmessage as a daemon:
There is information here: [https://bitmessage.org/wiki/Daemon Daemon-Mode]

== Upgrading ==
; To upgrade Bitmessage run the following commands:
cd $HOME/PyBitmessage
git pull

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-08-22T17:01:28Z

Mtkfm: No need to cd into the directory; git command only updated src/ directory

This page should help novice users run Bitmessage from the source code files.

= Linux =
== Fedora + RHEL ==
'''Install dependencies:'''

''Fedora and RHEL6 do not support EC in OpenSSL. Therefore we need [http://linux.ringingliberty.com/bitcoin/ Ringing Liberty's bitcoin repository] to get a compatible library.''

Repository for Fedora:
su -c 'yum install http://linux.ringingliberty.com/bitcoin/f18/x86_64/bitcoin-release-1-4.noarch.rpm'
or this one for RedHat Enterprise Linux (RHEL):
su -c 'yum install http://linux.ringingliberty.com/bitcoin/el6/x86_64/bitcoin-release-1-4.noarch.rpm'
Install dependencies:
su -c 'yum install python git openssl-compat-bitcoin-libs'
'''Download''' Bitmessage from GIT:
git clone https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage
'''Run''' Bitmessage:
cd $HOME/PyBitmessage/src/ && LD_LIBRARY_PATH="/opt/openssl-compat-bitcoin/lib/" python bitmessagemain.py

== Other Distributions ==

''Note for Debian Squeeze (6.0) users: Debian Squeeze does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems].''

For Whonix (0.5.6) installation, follow the steps for Debian.

; Install dependencies:
: APT-based distributions (Debian, Ubuntu): <code>sudo apt-get install python openssl git python-qt4</code>
: Raspberry Pi (Raspbian "wheezy", PiBang): <code>sudo apt-get install python-qt4</code>
: RPM-based distributions (Red Hat, Fedora): <code>sudo yum install python openssl git</code>
: Arch: <code>sudo pacman -S python2 openssl git python2-pyqt4</code>

; Download and run Bitmessage:
git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki>
~/PyBitmessage/src/bitmessagemain.py

; You can also run Bitmessage as a daemon:
There is information here: [https://bitmessage.org/wiki/Daemon Daemon-Mode]

== Upgrading ==
; To upgrade Bitmessage run the following commands:
cd $HOME/PyBitmessage
git pull

= OS X =
== With Homebrew package manager ==
; Setup
First, make sure you have not already installed Macports. Having both macports and homebrew on the same system is a recipe for disaster.
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)"

Update Python:
brew install python

; Install dependencies:
brew install pyqt openssl

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python src/bitmessagemain.py

== With macports package manager ==
First, make sure you have not already installed Homebrew. Having both macports and homebrew on the same system is a recipe for disaster.
Installing with macports or homebrew essentially has the same effect. Homebrew does some things better than ports, and ports does some things better than brew. If old-school floats your boat, these instructions are for you.

; Select the macports installation that is right for your version of osx
https://www.macports.org/install.php

; Install dependencies and needed tools
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb

; Download and run
cd ~/Desktop
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage
python2.7 src/bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy Bitmessage's 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="src\images\can-icon.ico" src\bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

If you do not have the libeay32.dll you can download it here. http://www.dll-files.com/dllindex/dll-files.shtml?libeay32

Compiling instructions

2013-05-14T17:41:05Z

Mtkfm: /* From source */ fixed command

This page should help novice users run Bitmessage from the source code files.

= Linux =
== Ubuntu ==
There's an unofficial Personal Package Archive for Pybitmessage which provides an easy way to get Pybitmessage. To install it, open a [https://help.ubuntu.com/community/UsingTheTerminal#Starting_a_Terminal Terminal] (press Ctrl+Alt+T) and enter the following:
sudo add-apt-repository -y ppa:fuzzgun/pybitmessage && sudo apt-get update
sudo apt-get install pybitmessage

== From source ==
''Note for Fedora users: Fedora does not currently compile EC into OpenSSL and thus will not work. A workaround is needed to either recompile OpenSSL, or locate/install a OpenSSL package that supports EC extensions.''

''Note for Debian Wheezy (6.0) users: Debian Wheezy does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems].''

; Install dependencies:
: APT-based distributions (Debian, Ubuntu): <code>sudo apt-get install python openssl git python-qt4</code>
: RPM-based distributions (Red Hat, Fedora): <code>sudo yum install python openssl git</code>

; Download and run Bitmessage:
git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki>
cd $HOME/PyBitmessage/src/ && python bitmessagemain.py

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy all of the source code files from the 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="images\can-icon.ico" bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

Compiling instructions

2013-05-13T20:45:18Z

Mtkfm: PPA instructions, Debian note

This page should help novice users run Bitmessage from the source code files.

= Linux =
== Ubuntu ==
There's an unofficial Personal Package Archive for Pybitmessage which provides an easy way to get Pybitmessage. To install it, open a [https://help.ubuntu.com/community/UsingTheTerminal#Starting_a_Terminal Terminal] (press Ctrl+Alt+T) and enter the following:
sudo add-apt-repository -y ppa:fuzzgun/pybitmessage && sudo apt-get update
sudo apt-get istall pybitmessage

== From source ==
''Note for Fedora users: Fedora does not currently compile EC into OpenSSL and thus will not work. A workaround is needed to either recompile OpenSSL, or locate/install a OpenSSL package that supports EC extensions.''

''Note for Debian Wheezy (6.0) users: Debian Wheezy does not offer packages (like Python, OpenSSL) in versions that are needed for Bitmessage. You can still try to [https://github.com/Bitmessage/PyBitmessage/issues/47#issuecomment-17774377 work around these problems].''

; Install dependencies:
: APT-based distributions (Debian, Ubuntu): <code>sudo apt-get install python openssl git python-qt4</code>
: RPM-based distributions (Red Hat, Fedora): <code>sudo yum install python openssl git</code>

; Download and run Bitmessage:
git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki>
python $HOME/PyBitmessage/src/bitmessagemain.py

Optionally create a startup script that runs '''python PyBitmessage/src/bitmessagemain.py'''

= Windows =
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

== If you change user interface files ==
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

== Optional: Compile into a stand-alone EXE ==
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy all of the source code files from the 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="images\can-icon.ico" bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

Compiling instructions

2013-05-03T19:24:10Z

Mtkfm: Linux instructions more consistent, some cleaning

This page should help novice users run Bitmessage from the source code files.

== Windows ==
# Download and install the latest revision of Python 2.7 (currently Python 2.7.3 from [http://www.python.org/download/releases/2.7.3/ here]). The ''Windows x86 MSI Installer'' is the right choice for most people. (64-bit users may want the 64-bit version).
# Test that it installed:
## Open a command prompt by going to Start > Run. Type 'cmd' then press enter.
## type 'python'. If python is installed, you should see the python version and the prompt: '>>>'
## If you see a message such as: "'Python is not recognized as an internal or external command..." then you must add the python path to your path environmental variable:
### Find the location where Python was installed (in particular, the location where python.exe exists). It might simply be in c:\Python2.7
### Follow [http://www.computerhope.com/issues/ch000549.htm these directions] to add the Python path to your path variable.
### Close the command prompt window and reopen it.
### Try running 'python' again.
##Press Ctrl-Z to exit Python.
# Bitmessage has two dependencies. The first is PyQt. Download and install PyQt from [http://www.riverbankcomputing.com/software/pyqt/download here]. You will want the Binary Package since it is already compiled for you. Be sure to select the version for Python 2.7. It is labeled as Py2.7.
# The second dependency is OpenSSL which you can download from [http://slproweb.com/products/Win32OpenSSL.html here]. There you will also notice the link to download the Visual C++ 2008 program in case you also find that you need that as well. (The OpenSSL installer will complain if you need to install the Visual C++ Redistributable.)
# Download the source code for PyBitmessage from GitHub. If it is in a zip file, you will need to extract it. There should be a few files and a few folders where one of the folders is 'src'.
# To run Bitmessage, navigate into the 'src' folder and then double click on the bitmessagemain.py file, or in a command prompt, change directories to the 'src' directory which holds bitmessagemain.py and type 'python bitmessagemain.py'.

=== If you change user interface files ===
You can use Qt's Designer application to modify the user interface. After you do this, you will need to 'compile' .ui files into .py files.
# In a command prompt, change directories to the directory of your .ui file.
# Run 'pyuic4 example.ui > example.py' If you get a message similar to 'pyuic4 is not recognized as an internal or external command' then you must add the PyQt directory to your system's path variable. This directory should hold pyuic4.bat. It might be in C:\Python27\Lib\site-packages\PyQt4. Remember to close the command window and reopen it after you change your path variable.

If you add icons to bitmessage_icons.qrc, then you must run this command:
pyrcc4 bitmessage_icons.qrc -o bitmessage_icons_rc.py

=== Optional: Compile into a stand-alone EXE ===
# Download [http://www.pyinstaller.org/ PyInstaller].
# Copy all of the source code files from the 'src' directory to the PyInstaller directory (which contains pyinstaller.py).
# Run 'pyinstaller.py --onefile --noconsole --icon="images\can-icon.ico" bitmessagemain.py'
This won't include the OpenSSL DLL file in the EXE; if you send it to someone who doesn't have OpenSSL installed, it will not run. To include the DLL file in the EXE, you must follow these steps:
# After following the steps above, you will see that pyinstaller created a folder called bitmessagemain. In that folder is a file: bitmessagemain.spec. Open it with a text editor.
# Below the line "a.datas," add this line: <code>a.binaries + [('libeay32.dll', 'c:\\windows\\system32\\libeay32.dll', 'BINARY')],</code>
# Save and close
# Run this command: pyinstaller.py bitmessagemain/bitmessagemain.spec

== Linux ==
''Note: Fedora does not currently compile EC into OpenSSL and thus will not work. A workaround is needed to either recompile OpenSSL, or locate/install a OpenSSL package that supports EC extensions.''

; Install dependencies:
: APT-based distributions (Debian, Ubuntu): <code>sudo apt-get install python openssl git python-qt4</code>
: RPM-based distributions (Red Hat, Fedora): <code>sudo yum install python openssl git</code>

; Download and run Bitmessage:
: <code>git clone <nowiki>https://github.com/Bitmessage/PyBitmessage $HOME/PyBitmessage</nowiki>
: python $HOME/PyBitmessage/src/bitmessagemain.py</code>

Optionally create a startup script that runs '''python PyBitmessage/src/bitmessagemain.py'''