PyBitmessage-2021-04-27/INSTALL.md

109 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

2017-05-09 21:57:52 +02:00
# PyBitmessage Installation Instructions
For an up-to-date version of these instructions, please visit the
[Bitmessage Wiki](https://bitmessage.org/wiki/Compiling_instructions).
PyBitmessage can be run in either one of two ways:
- straight from source
or
- from an installed
2015-01-14 15:19:06 +01:00
package.
2017-05-09 21:57:52 +02:00
## Dependencies
2015-01-14 15:19:06 +01:00
Before running PyBitmessage, make sure you have all the necessary dependencies
installed on your system.
Here's a list of dependencies needed for PyBitmessage
- python2.7
- python2-qt4 (python-qt4 on Debian/Ubuntu)
- openssl
- (Fedora & Redhat only) openssl-compat-bitcoin-libs
2017-05-09 21:57:52 +02:00
## Running PyBitmessage
PyBitmessage can be run in two ways:
- straight from source
or
- via a package which is installed on your system. Since PyBitmessage is Beta, it is best to run
PyBitmessage from source, so that you may update as needed.
2017-05-09 21:57:52 +02:00
#### Updating
To update PyBitmessage from source (Linux/OS X), you can do these easy steps:
```
cd PyBitmessage/src/
git fetch --all
git reset --hard origin/master
python bitmessagemain.py
```
Voilà! Bitmessage is updated!
2017-05-09 21:57:52 +02:00
#### Linux
To run PyBitmessage from the command-line, you must download the source, then
run `src/bitmessagemain.py`.
```
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage/ && python src/bitmessagemain.py
```
That's it! *Honestly*!
2017-05-09 21:57:52 +02:00
#### Windows
2015-01-14 15:19:06 +01:00
On Windows you can download an executable for Bitmessage
[here](https://github.com/Bitmessage/PyBitmessage/releases/download/0.6.3.2/Bitmessage_x86_0.6.3.2.exe).
However, if you would like to run PyBitmessage via Python in Windows, you can
go [here](https://bitmessage.org/wiki/Compiling_instructions#Windows) for
information on how to do so.
2017-05-09 21:57:52 +02:00
#### OS X
First off, install Homebrew.
```
2015-01-14 15:19:06 +01:00
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
Now, install the required dependencies
```
2019-01-01 08:15:23 +01:00
brew install git python openssl cartr/qt4/pyqt@4
```
Download and run PyBitmessage:
```
git clone git://github.com/Bitmessage/PyBitmessage.git
cd PyBitmessage && python src/bitmessagemain.py
```
2017-05-09 21:57:52 +02:00
## Creating a package for installation
2014-01-24 17:16:28 +01:00
If you really want, you can make a package for PyBitmessage, which you may
install yourself or distribute to friends. This isn't recommended, since
PyBitmessage is in Beta, and subject to frequent change.
2017-05-09 21:57:52 +02:00
#### Linux
First off, since PyBitmessage uses something nifty called
[packagemonkey](https://github.com/fuzzgun/packagemonkey), go ahead and get
that installed. You may have to build it from source.
2014-01-24 17:16:28 +01:00
Next, edit the generate.sh script to your liking.
Now, run the appropriate script for the type of package you'd like to make
```
arch.sh - create a package for Arch Linux
debian.sh - create a package for Debian/Ubuntu
ebuild.sh - create a package for Gentoo
osx.sh - create a package for OS X
puppy.sh - create a package for Puppy Linux
rpm.sh - create a RPM package
slack.sh - create a package for Slackware
```
2017-05-09 21:57:52 +02:00
#### OS X
Please refer to
[this page](https://bitmessage.org/forum/index.php/topic,2761.0.html) on the
forums for instructions on how to create a package on OS X.
Please note that some versions of OS X don't work.
2017-05-09 21:57:52 +02:00
#### Windows
## TODO: Create Windows package creation instructions