README.md

   1 Requirements:
   2 -------------------------
   3 Generic:
   4 * Bitcoin >=0.6.4
   5 * Python
   6 * Twisted
   7 * python-argparse (for Python <=2.6)
   8
   9 Linux:
  10 * sudo apt-get install python-zope.interface python-twisted python-twisted-web
  11 * sudo apt-get install python-argparse # if on Python 2.6 or older
  12
  13 Windows:
  14 * Install Python 2.7: http://www.python.org/getit/
  15 * Install Twisted: http://twistedmatrix.com/trac/wiki/Downloads
  16 * Install Zope.Interface: http://pypi.python.org/pypi/zope.interface/3.8.0
  17 * Install python win32 api: http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/
  18 * Install python win32 api wmi wrapper: https://pypi.python.org/pypi/WMI/#downloads
  19 * Unzip the files into C:\Python27\Lib\site-packages
  20
  21 Running P2Pool:
  22 -------------------------
  23 To use P2Pool, you must be running your own local bitcoind. For standard
  24 configurations, using P2Pool should be as simple as:
  25
  26     python run_p2pool.py
  27
  28 Then run your miner program, connecting to 127.0.0.1 on port 9332 with any
  29 username and password.
  30
  31 If you are behind a NAT, you should enable TCP port forwarding on your
  32 router. Forward port 9333 to the host running P2Pool.
  33
  34 Run for additional options.
  35
  36     python run_p2pool.py --help
  37
  38 Donations towards further development:
  39 -------------------------
  40     1HNeqi3pJRNvXybNX4FKzZgYJsdTSqJTbk
  41
  42 Official wiki :
  43 -------------------------
  44 https://en.bitcoin.it/wiki/P2Pool
  45
  46 Alternate web front end :
  47 -------------------------
  48 * https://github.com/hardcpp/P2PoolExtendedFrontEnd
  49
  50 Notes for Litecoin:
  51 =========================
  52 Requirements:
  53 -------------------------
  54 In order to run P2Pool with the Litecoin network, you would need to build and install the
  55 ltc_scrypt module that includes the scrypt proof of work code that Litecoin uses for hashes.
  56
  57 Linux:
  58
  59     cd litecoin_scrypt
  60     sudo python setup.py install
  61
  62 Windows (mingw):
  63 * Install MinGW: http://www.mingw.org/wiki/Getting_Started
  64 * Install Python 2.7: http://www.python.org/getit/
  65
  66 In bash type this:
  67
  68     cd litecoin_scrypt
  69     C:\Python27\python.exe setup.py build --compile=mingw32 install
  70
  71 Windows (microsoft visual c++)
  72 * Open visual studio console
  73
  74 In bash type this:
  75
  76     SET VS90COMNTOOLS=%VS110COMNTOOLS%             # For visual c++ 2012
  77     SET VS90COMNTOOLS=%VS100COMNTOOLS%             # For visual c++ 2010
  78     cd litecoin_scrypt
  79     C:\Python27\python.exe setup.py build --compile=mingw32 install
  80
  81 If you run into an error with unrecognized command line option '-mno-cygwin', see this:
  82 http://stackoverflow.com/questions/6034390/compiling-with-cython-and-mingw-produces-gcc-error-unrecognized-command-line-o
  83
  84 Running P2Pool:
  85 -------------------------
  86 Run P2Pool with the "--net litecoin" option.
  87 Run your miner program, connecting to 127.0.0.1 on port 9327.
  88 Forward port 9338 to the host running P2Pool.
  89
  90 Litecoin's use of ports 9332 and 9332 conflicts with P2Pool running on
  91 the Bitcoin network. To avoid problems, add these lines to litecoin.conf
  92 and restart litecoind:
  93
  94     rpcport=10332
  95     port=10333