php-mpos

OS Setup

My base system used in this guide is Ubuntu Server 12.04 LTS. During setup I kept most defaults and installed the OpenSSH (for easier access) and LAMP Server groups during software selection. Other software and tools required will be mentioned in this guide.

sudo vi /etc/apt/sources.list

#163源

deb http://mirrors.163.com/ubuntu/ raring main universe restricted multiverse

deb-src http://mirrors.163.com/ubuntu/ raring main universe restricted multiverse

deb http://mirrors.163.com/ubuntu/ raring-security universe main multiverse restricted

deb-src http://mirrors.163.com/ubuntu/ raring-security universe main multiverse restricted

deb http://mirrors.163.com/ubuntu/ raring-updates universe main multiverse restricted

deb http://mirrors.163.com/ubuntu/ raring-proposed universe main multiverse restricted

deb-src http://mirrors.163.com/ubuntu/ raring-proposed universe main multiverse restricted

deb http://mirrors.163.com/ubuntu/ raring-backports universe main multiverse restricted

deb-src http://mirrors.163.com/ubuntu/ raring-backports universe main multiverse restricted

deb-src http://mirrors.163.com/ubuntu/ raring-updates universe main multiverse restricted

#中国科技大学

#deb http://debian.ustc.edu.cn/ubuntu/ raring main restricted universe multiverse

#deb http://debian.ustc.edu.cn/ubuntu/ raring-backports restricted universe multiverse

#deb http://debian.ustc.edu.cn/ubuntu/ raring-proposed main restricted universe multiverse

#deb http://debian.ustc.edu.cn/ubuntu/ raring-security main restricted universe multiverse

#deb http://debian.ustc.edu.cn/ubuntu/ raring-updates main restricted universe multiverse

#deb-src http://debian.ustc.edu.cn/ubuntu/ raring main restricted universe multiverse

#deb-src http://debian.ustc.edu.cn/ubuntu/ raring-backports main restricted universe multiverse

#deb-src http://debian.ustc.edu.cn/ubuntu/ raring-proposed main restricted universe multiverse

#deb-src http://debian.ustc.edu.cn/ubuntu/ raring-security main restricted universe multiverse

#deb-src http://debian.ustc.edu.cn/ubuntu/ raring-updates main restricted universe multiverse

#上海交通大学（上海交大源，教育网的速度不用说了）

#deb http://ftp.sjtu.edu.cn/ubuntu/ raring main multiverse restricted universe

#deb http://ftp.sjtu.edu.cn/ubuntu/ raring-backports main multiverse restricted universe

#deb http://ftp.sjtu.edu.cn/ubuntu/ raring-proposed main multiverse restricted universe

#deb http://ftp.sjtu.edu.cn/ubuntu/ raring-security main multiverse restricted universe

#deb http://ftp.sjtu.edu.cn/ubuntu/ raring-updates main multiverse restricted universe

#deb http://ftp.sjtu.edu.cn/ubuntu-cn/ raring main multiverse restricted universe

#deb-src http://ftp.sjtu.edu.cn/ubuntu/ raring main multiverse restricted universe

#deb-src http://ftp.sjtu.edu.cn/ubuntu/ raring-backports main multiverse restricted universe

#deb-src http://ftp.sjtu.edu.cn/ubuntu/ raring-proposed main multiverse restricted universe

#deb-src http://ftp.sjtu.edu.cn/ubuntu/ raring-security main multiverse restricted universe

#deb-src http://ftp.sjtu.edu.cn/ubuntu/ raring-updates main multiverse restricted universe

Update your server:

sudo apt-get updatesudo apt-get dist-upgrade

Run these two commands till there are no more updates. Remember to run these commands again any time you install dependencies to make sure you have the latest versions.

In order to get started install some basic tools. Other tools will be installed when needed.

sudo apt-get install gitsudo apt-get install build-essential libboost-all-dev libcurl4-openssl-dev libdb5.1-dev libdb5.1++-dev mysql-server autoconf libtool

Litecoind

Download

You can grab the latest version from Litecoin @ Github:

cd ~git clone git://github.com/litecoin-project/litecoin.git

#BTC

#git clone https://github.com/bitcoin/bitcoin/

Compile

With the source downloaded and all dependencies installed we can now try to compile litecoind:

# Change to src foldercd ~cd litecoin/src# Compile litecoindmake -f makefile.unix USE_UPNP=-# Copy to system pathsudo cp litecoind /usr/bin

Test Network

Now that we have a working executable we can fetch the testnet for Litecoin from Github:

cd ~git clone git://github.com/xrobau/litecoin-testnet-box.gitcd litecoin-testnet-box

The included .conf in the /1 folder will not function properly if the username and password remain the same, so you will have to edit the file so that one of them does not match the other.

vi 1/litecoin.conf

Now you can start your server.

make start

If everything went well you should now get some information from the RPCs, this data can vary depending on version numbers used and changes to the net since the first access:

root@ubuntu-server:~/litecoin-testnet-box# make getinfolitecoind -datadir=1  getinfo{    "version" : 60300,    "protocolversion" : 60001,    "walletversion" : 60000,    "balance" : 0.00000000,    "blocks" : 0,    "connections" : 1,    "proxy" : "",    "difficulty" : 0.00024414,    "testnet" : true,    "keypoololdest" : 1369211361,    "keypoolsize" : 101,    "paytxfee" : 0.00000000,    "mininput" : 0.00010000,    "errors" : ""}litecoind -datadir=2  getinfo{    "version" : 60300,    "protocolversion" : 60001,    "walletversion" : 60000,    "balance" : 0.00000000,    "blocks" : 0,    "connections" : 1,    "proxy" : "",    "difficulty" : 0.00024414,    "testnet" : true,    "keypoololdest" : 1369211361,    "keypoolsize" : 101,    "paytxfee" : 0.00000000,    "mininput" : 0.00010000,    "errors" : ""}

Success! Litecoin is now setup and working properly running on a test network. No actual blocks are calculated here but this is enough for testing purposes later.

You can fetch your wallet address via litecoind inside your testnet checkout from the testnet folder:

litecoind -datadir=1 getaccountaddress ""

Remember this address, you'll need it later.

To mine on this server with a remote graphic card on your network you need to determine your machines IP.

ifconfig

Now point your miner, I will be using cgminer.

cgminer.exe --scrypt -o http://yourip:19334 -u -p

You should now be mining!

Stratum Mining

Stratum Mining is a software which supports all PoW and PoS coins including Litecoin, Bitcoin, PPcoin and Novacoin.This is rather easy to implement so here a quick start guide if you wish to try it out. MPOS does support stratum, For VARDIFF support MPOS must be set to match the initial pool target in the stratum-mining config file.

Requirements

First we need to install some packages required to run stratum-mining:

cd ~sudo apt-get install python-twisted python-mysqldb python-dev python-setuptools python-memcache python-simplejson python-pylibmcsudo easy_install -U distribute

Downloading

We need to fetch stratum-mining and some additional code for a stratum implementation:

git clone https://github.com/Tydus/litecoin_scrypt.gitgit clone https://github.com/ahmedbodi/stratum-mining.gitgit clone https://github.com/ahmedbodi/stratum.git

That covers the download. Lets go ahead and prepare the software!

Installation

We need to install litecoin_scrypt and stratum:

cd stratum-mininggit submodule initgit submodule updatecd externals/litecoin_scryptsudo python setup.py installcd ~cd stratum-mining/externals/stratumsudo python setup.py install

Configuration

Now that we have everything installed we can configure stratum-mining to run with our testnet:

cd ~cp stratum-mining/conf/config_sample.py stratum-mining/conf/config.pyvi stratum-mining/conf/config.py

You will need to adjust some settings for this to work:

CENTRAL_WALLET = 'Your_Valid_Bitcoin_or_Litecoin_Address'[...]COINDAEMON_TRUSTED_HOST = 'localhost'COINDAEMON_TRUSTED_PORT = 19334COINDAEMON_TRUSTED_USER = 'testnet'COINDAEMON_TRUSTED_PASSWORD = 'testnet'COINDAEMON_ALGO = 'scrypt'COINDAEMON_Reward = 'POW'COINDAEMON_SHA256_TX = 'no[...]HOSTNAME = 'yourservername'[...]DATABASE_DRIVER = 'mysql'DB_MYSQL_HOST = 'localhost'DB_MYSQL_DBNAME = 'mpos'DB_MYSQL_USER = 'root'DB_MYSQL_PASS = 'root'[...]POOL_TARGET = 16[...]SOLUTION_BLOCK_HASH = True#stratum+tcp:portLISTEN_SOCKET_TRANSPORT = 3333#自动添加用户USERS_AUTOADD = True

Starting stratum-mining

This is the easy part, but don't do it till you set up the database in the next steps. Change to the stratum-mining folder and fire up the service:

cd stratum-miningtwistd -ny launcher.tac

If you want to run it in the background you can remove the -ny and replace it with -y:

twistd -y launcher.tac

Special Notes

When running stratum-mining I noticed that stratum and pushpoold use different settings. @pooler was nice enough to explain it to me in detail:

pushpoold uses a target bits terminology and stratum a difficulty setting. These are different. When running pushpoold at a target bit of 20 you will match the default setting of 16 in stratum-mining. This will ensure that hashrates on MPOSmatch up! If you'd think you could set pushpoold to 16 and match it with stratum you will be off.

He devised a formula that can be used to change stratum difficulty and match pushpoold and MPOS to it:

(stratum diff) ~= 2^((target bits in pushpool) - 16)

Add The Result To The Stratum Pool_Target

MPOS

Requirements

We need to install some additional software to ensure MPOS will work as expected. This is a sample for Debian based systems:

sudo apt-get install memcached php5-memcached php5-mysqlnd php5-curl php5-json libapache2-mod-php5sudo apache2ctl -k stop; sleep 2; sudo apache2ctl -k start

Also, please download and check out the security warnings and errors triggered by phpsecinfo and fix those before attempting to run MPOS: http://phpsec.org/projects/phpsecinfo/

Just download the ZIP archive, unzip into your pools webroot and run the index.php. Do not continue until everything shows green! The only exception is Maximum post size which needs to be a bit bigger so MPOS can store admin panel settings to the DB when clicking save.

Download

Fetch the latest version of MPOS:

# We move into the default webroot of Ubuntucd /var/wwwsudo git clone git://github.com/MPOS/php-mpos.git MPOScd MPOSsudo git checkout master

Mailserver Setup

To allow your site to send messages you need to set up the mail server.

sudo apt-get install postfix

Accept 'internet server' and keep the defaults. This will set up Postfix.

Database Setup

During server installation MySQL was installed by using the LAMP Server group. This also setup a password for yourroot user. Use this password now to create the database and import the structure:

# Create databasesudo mysql -p -e "create database mpos"# Import structuresudo mysql -p mpos < sql/000_base_structure.sql

Configuration

Folder Permissions

First, give proper permissions to our compiled templates and caching folder. This example shows the procedure inUbuntu, other distributions may vary (apache in CentOS, httpd in others). Ensure to give the service user access that will be executing the scripts!

sudo chown -R www-data public/templates/compile public/templates/cache logs

Main Configuration

We need to configure the project to work on our newly installed server:

sudo cp public/include/config/global.inc.dist.php public/include/config/global.inc.php

Now edit the configuration file and adjust the settings to match your database and litecoin RPC Client:

$config['db']['host'] = 'localhost';$config['db']['user'] = 'root';$config['db']['pass'] = 'root';$config['db']['port'] = 3306;$config['db']['name'] = 'mpos';[...]$config['wallet']['type'] = 'http';$config['wallet']['host'] = 'localhost:19334';$config['wallet']['username'] = 'testnet';$config['wallet']['password'] = 'testnet';[...]$config['gettingstarted']['stratumurl'] = 'localhost';

You will also need to setup a proper, random (!) $config['SALT'] and another $config['SALTY'] secret! If you forgot that, you will get an error message after installing MPOS: You absolutely SHOULD NOT leave your SALT or SALTY default changing them will require registering again. SALT and SALTY must be a minimum of 24 characters or you will get an error message: 'SALT or SALTY is too short, they should be more than 24 characters and changing them will require registering again'

One final edit should be to edit: /usr/local/lib/python2.7/dist-packages/stratum-0.2.13-py2.7.egg/stratum/websocket_transport.py

Change:

from autobahn.websocket import WebSocketServerProtocol, WebSocketServerFactory

To:

from autobahn.twisted.websocket import WebSocketServerProtocol, WebSocketServerFactory

Now everything is setup and we should be able to test things.

Testing

MPOS

Open your browser and head over to MPOS on your server `http:///MPOS/public

You should be greeted with the homepage. Create a new account on the registration page (the first account will have admin rights and does not require a mail confirmation) and add a new worker!

Test the Pool

Now with everything in place and running you can fire up a miner of your choice and test if shares are committed:

minerd -o stratum+tcp://<yourserverIP>:3333 -O YourAccount.worker:WorkerPassword -t 1

If all went well you should see this:

minerd -o stratum+tcp://localhost:3333 -O DummyUser.test:test -t 1[2013-05-22 11:01:20] 1 miner threads started, using 'scrypt' algorithm.[...][2013-05-22 11:01:21] thread 0: 4104 hashes, 6.38 khash/s[2013-05-22 11:01:34] thread 0: 137208 hashes, 10.85 khash/s[2013-05-22 11:01:34] accepted: 1/1 (100.00%), 10.85 khash/s (yay!!!)[2013-05-22 11:01:34] thread 0: 288 hashes, 10.66 khash/s

Please test the same with cgminer or a similar tool supporting stratum on port 3333, the default port opened by the configuration in stratum-mining.

Now with shares being committed and new blocks being generated in our test network head to the webinterface and your stats should be updated!

Cronjobs

MPOS comes with a few cronjobs that are part of the backend. Please set the up according to regular cron guides. MPOScomes with a wrapper script that will run all crons for you. It is called run-crons.sh and can be found in the cronjobs folder. Adjust this script to suit your needs, then add it to your cron service.

For testing purposes you can also run them from command line:

cd /var/www/MPOS/cronjobs./run-crons.sh

You will not receive any output. Please check in cronjobs/logs for the appropriate logfiles. For more detailed logs you can turn on debugging in the cronjobs/shared.inc.php file.

For a small pool, this will work fine. If you are planning to run a medium sized pool in the future or expect a lot of shares, please read: cronjob advanced setup.

E-Mail

You are required to have a proper mail setup running on your box. Keep in mind that large pools can have quite excessive mails being send over all. This is by design and increases security while also notifying uses about state changes in the pool. For smaller pools, running via an external provider will suffice. For larger once, you should look into a contract for Mail Relays.

A simple guide to get started with Gmail and Postfix can be found here: https://rtcamp.com/tutorials/linux/ubuntu-postfix-gmail-smtp/

Basic DoS Protection

You are required to secure your server, Using internal and external means. Pasting the below rules into your SSH console one line at a time from top to bottom would be a good start, But there are other considerations as well.

This assumes you will be using port 53 for DNS and you don't want UDP for anything else, And your webserver is serving on port 80, This doesn't restrict services such as SSH or FTP. You want to limit the rate your clients can connect at the door, and not rely solely on a cache to do it.

sudo iptables -A INPUT -p tcp --dport 80 -m state --state NEW -m limit --limit 50/minute --limit-burst 200 -j ACCEPT
sudo iptables -A INPUT -m state --state RELATED,ESTABLISHED -m limit --limit 50/second --limit-burst 50 -j ACCEPT 
sudo iptables -A INPUT -i eth0 -p tcp -m tcp --tcp-flags FIN,SYN,RST,PSH,ACK,URG NONE -j DROP 
sudo iptables -A INPUT -i eth0 -p tcp -m tcp --tcp-flags FIN,SYN FIN,SYN -j DROP
sudo iptables -A INPUT -i eth0 -p tcp -m tcp --tcp-flags SYN,RST SYN,RST -j DROP
sudo iptables -A INPUT -i eth0 -p tcp -m tcp --tcp-flags FIN,RST FIN,RST -j DROP
sudo iptables -A INPUT -i eth0 -p tcp -m tcp --tcp-flags FIN,ACK FIN -j DROP 
sudo iptables -A INPUT -i eth0 -p tcp -m tcp --tcp-flags ACK,URG URG -j DROP 
sudo iptables -A PORT_SCANNING -p tcp --tcp-flags SYN,ACK,FIN,RST RST -m limit --limit 1/s -j RETURN
sudo iptables -A PORT-SCANNING j DROP 
sudo iptables -A INPUT -p icmp -m limit --limit 2/second --limit-burst 2 -j ACCEPT
sudo iptables -A INPUT -p tcp --tcp-flags ALL FIN,PSH,URG -j DROP 
sudo iptables -A INPUT -p udp --sport 53 -j ACCEPT
sudo iptables -A INPUT -p udp --dport 53 -j ACCEPT
sudo iptables -A OUTPUT -p udp --sport 53 -j ACCEPT
sudo iptables -A OUTPUT -p udp --dport 53 -j ACCEPT
sudo iptables -A INPUT -p udp -j DROP
sudo iptables -A OUTPUT -p udp -j DROP

You can find a more detailed explanation of what these do: HERE

Conclusion

Congratulations! You have now a running instance of MPOS to test with! Please consider donating if you like my work and find this guide helpful!

Quick Start

Follow these instructions to perform this entire setup, minus the file configurations, in a quick and efficient bundle.

cd ~sudo apt-get updatesudo apt-get dist-upgradesudo apt-get install gitsudo apt-get install build-essential libboost-all-dev libcurl4-openssl-dev libdb5.1-dev libdb5.1++-devgit clone git://github.com/litecoin-project/litecoin.gitcd litecoin/srcmake -f makefile.unix USE_UPNP=-sudo cp litecoind /usr/bincd ~git clone git://github.com/xrobau/litecoin-testnet-box.gitcd litecoin-testnet-boxcd ~sudo apt-get install python-twisted python-mysqldb python-dev python-setuptools python-memcache python-simplejsoneasy_install -U distributegit clone https://github.com/Tydus/litecoin_scrypt.gitgit clone https://github.com/ahmedbodi/stratum-mining.gitgit clone https://github.com/ahmedbodi/stratum.gitcd stratum-mininggit submodule initgit submodule updatecd externals/litecoin_scryptsudo python setup.py installcd ~cd stratum-mining/externals/stratumsudo python setup.py installcd ~cp stratum-mining/conf/config_sample.py stratum-mining/conf/config.pysudo apt-get install memcached php5-memcached php5-mysqlnd php5-curlsudo apache2ctl -k stop; sleep 2; sudo apache2ctl -k startcd ..cd ..cd var/wwwsudo git clone git://github.com/MPOS/php-mpos.git MPOScd MPOSsudo git checkout mastermysql -u -p -e "create database mpos"mysql -u -p mpos < sql/000_base_structure.sqlsudo chown -R www-data public/templates/compile public/templates/cachesudo cp public/include/config/global.inc.dist.php public/include/config/global.inc.php

Helpful Hints

Make sure you allow for 2 Gb of RAM in memory settings, if you leave it at the default 512 Mb some compiling commands won't be able to execute properly.

Or you can create a pagefile if more RAM is not available by using these commands.

sudo dd if=/dev/zero of=/swapfile bs=1024 count=2048ksudo mkswap /swapfilesudo chown root:root /swapfilesudo chmod 0600 /swapfilesudo swapon /swapfile

This is temporary unless you add the file to your fstab.

sudo vi /etc/fstabAdd the following line to the end of the file/swapfile1 swap swap defaults 0 0

Remember to set VMware to bridge your adapter so that your server will show up on the local network.

The server can be really touchy when trying to get a miner to connect to it. Keep trying, restart, fiddle with the .conf settings, etc, eventually it will begin working properly, though I had to create the server 8 times before it worked.

If easy_install doesn't work then run these additional lines first.

cd ~sudo rm /usr/bin/easy_install*sudo rm /usr/local/bin/easy_install*curl -O http://python-distribute.org/distribute_setup.pysudo python distribute_setup.pysudo rm distribute_setup.py

This will compile and install two libraries that are required to run stratum-mining. If running the git commands does not pull the git subfiles the first time, try deleting the stratum-mining folder and downloading it again.

To remove the slightly annoying "Could not reliably determine server name" warning message when restarting apache, just insert this line of code into the /etc/apache2/httpd.conf file:

ServerName yourservername