ff2f5fbca4f9f5e051677a3799a2cf157abd3cc5
[p2pool.git] / README
1 Requirements:
2
3 * Bitcoin >=0.5.0
4 * Python
5 * Twisted
6 * python-argparse (for Python <=2.6)
7
8 Linux:
9     sudo apt-get install python-zope.interface python-twisted python-twisted-web
10     sudo apt-get install python-argparse # if on Python 2.6 or older
11
12 Windows:
13     Install Python 2.7: http://www.python.org/getit/
14     Install Twisted: http://twistedmatrix.com/trac/wiki/Downloads
15     Install Zope.Interface: http://pypi.python.org/pypi/zope.interface/3.8.0
16         unzip the files into C:\Python27\Lib\site-packages
17
18
19 To use p2pool, you must be running your own local bitcoind. p2pool connects to
20 this bitcoin over both its p2p interface and its RPC interface. For standard
21 configurations, using p2p should be as simple as:
22
23     python run_p2pool.py <rpc_username> <rpc_password>
24
25 Then run your miner program, connecting to 127.0.0.1 on port 9332 with any
26 username and password.
27
28
29 If you are behind a NAT, it will help to enable TCP port forwarding on your
30 router. Forward port 9333 to the host running p2pool.py.
31
32
33 Use
34
35     python run_p2pool.py --help
36
37 for additional options.