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