This page will basically be the official documentation of the plugin and will explain everything you need to know from start to finish in order to start your own Bitcoin faucet with WordPress.
Keep in mind that this is a free plugin and I don’t have a lot of time to maintain it, that’s why so of the user interface looks a bit weird and I will have limited time to answer support requests. However I will do the best I can in order to keep this plugin working and up to date. Also I will mainly use video tutorials in order to explain about the faucet and not written tutorials (it’s just faster for me to create them).
If you don’t know what a Bitcoin faucet is I suggest starting with this post that will describe most of what you need to know about the subject and how you can make a business from it. When you get to the part on how to build a Bitcoin faucet come back to this page to learn the easier way than what is described in the original post.
So let’s get down to building your WordPress Bitcoin Faucet:
1. Get a hosting provider and install WordPress on it
This is the very basics of what you’ll need. I’m assuming you already know how to do this, if you don’t then I’m posting a video here that explains how to set up WordPress. Any hosting provider should do the trick, I personally use Bluehost for these types of project.
2. Install the Bitcoin Faucet WordPress Plugin
- Download the Bitcoin Faucet WordPress Plugin – Download link
- Go to “plugins” -> Add new -> Upload plugin
- Choose the file you’ve just downloaded and upload it to your site
- After the upload is compete click on “activate plugin”
3. Get an ePay/Faucethub and a captcha account
- Go to ePay or Faucethub and create an account (I suggest Faucethub, ePay has a a lot of payment issues)
- Add your site’s URL to the account
- Go to SolveMedia / Recaptcha and create an account (I suggest SolveMedia since they are also a revenue source)
- Add your site’s URL to the account
4. Set up the plugin
This faucet has A LOT of options. Since I don’t have time to write them all down I created a video explaining everything you need to know about the faucet. Note that at the moment the video shows Faucetbox as an option and not ePay. Faucetbox have gone out of business but the process is basically the same for ePay. I will put out a new video soon:
The minimum requirements to get the plugin running:
Under the “general” tab
- Enter your payouts and timer settings
- Enter your SolveMedia API keys
- Enter the URLs for your faucet page and “check address” page (at the bottom of the “general” tab)
- The referral link URL scheme is this: http://yourwebsite.com/?r=btc_address
Under the “payment” tab
- Enter your ePay / Fuacethub API keys
On your faucet page:
- Enter the faucet shortcode (make sure to enter it AFTER all other shortcodes)
5. Require registration for your faucet (optional)
Once of the best ways I’ve found to fight off spam is by requiring users to register to my site in order to use it. This deters most spammers and bots from the site. I use a paid plugin called “Wishlist Member” that takes care of setting up this registration process. This is not a must, but if you feel like you’re getting too many scammers on your site it’s worth to look into it.
6. Set up your own server for micro payments (advanced, optional)
If you wish to use your own self hosted Bitcoin wallet to do payments instead of ePay or Faucethub you can install a Bitcoin wallet on a VPS (Virtual Private Server). The whole process is documented here but it’s recommended to do so only if you have some technical background. Keep in mind I will not be able to support any installation issues for a self hosted wallet.
I HIGHLY RECOMMEND WATCHING THE SETUP VIDEO ABOVE FROM START TO FINISH TO UNDERSTAND HOW THE FAUCET WORKS (ALL CAPS, SO YOU’LL KNOW IT’S IMPORTANT).
Now that you’re good to go I suggest going back to the original post and reading everything that doesn’t involve setting up the faucet – it’s crucial information.
A few important things to remember:
- Payments are made through ePay / Faucethub but you will have to click the “make payment” button in order to send all addresses that qualify for payment to ePay /Faucethub.
- Make sure your ePay /Faucethub account is funded or addresses won’t be queued for payout.
- Make sure to limit your ePay account only to your IP address. There have been several issues with ePay in the past and this will probably prevent them. You can find your server IP address here.
- From personal experience I suggest allowing user comments on your faucet – it’s the fastest way to know that something is not working right.
- At the moment the only data I gather from these faucets is how much is being paid – that’s all. No passwords, bitcoin addresses or any other sensitive information is being passed along. Just a number of how many Satoshis have been queued for payment each time you click “make payment”.
Getting support / Frequently Asked Questions
Most of your faucet problems can be solved through the use of the frequently asked questions listed below. If you can find the answer in them, feel free to submit a support request.
- I'm not seeing the faucet form on my webpage
- Please make sure you added the faucet’s shortcode to the page as shown in the installation video. The shortcodes are listed in the “support” section under “how to use”
- I'm getting a 404 error when claiming on the faucet or checking an address balance
- This means you probably didn’t set up the URLs correctly under the “general” tab:
- my payment isn't processing
After you click “make payment” your should see the balance move from “Unpaid above threshold” to “Scheduled payment amount”
This means that payment is now scheduled and in the next 20 minutes it will be sent to your microwallet. If that doesn’t happen there are several things you should look into:
- If you’re using ePay know that this service has a lot of issues – we suggest using Faucethub.
- The payment that is scheduled is too small – usually microwallets have thresholds of which they accept payments. Make sure the payment is at least 20,000 Satoshis
- If you’re using Faucethub’s api you need to know that each user on your faucet must have a Faucethub account linked to their address in order to get paid. So if for example, you have 10 faucet users and non of their addresses are registered with Faucethub, payment won’t go through.
- Sometimes microwallets fail to process payment. In this case just click “make payment” again and give it another try. In the newer versions of the plugin we will continue to try and send the payment until it goes through.
- I have an issue with the captcha on the site
All captcha issues should be addresses to the captcha provider as we just use their API to show their captcha on the site. Sometimes that captcha issuer will have downtime or server issues and the captcha won’t show up, this has nothing to do with the plugin.
- I have an issue that isn't listed here
As of January 2017 the plugin now offers support for a small fee of your payouts (0.5%). In order to request support go to the “support” tab and hit “request support”. Please make sure to add wp-admin and ftp access if possible. Support requests will be responded within 36 hours. You can also opt out of support for the plugin if you do not wish to pay the fee. In that case I will not be able to help out and you will not receive automatic plugin updates.
April 24th 2017:
= 1.7.5 =
Storing ref address in cookies so people can pass registration without loosing referrals.
= 1.7.4 =
Configuration option to specify how to load captcha: regular, ajax and lazy.
Fixing issue with chart render.
Updating stats requests to send data to domain instead of ip address.
= 1.7.3 =
New support address
= 1.7.2 =
Fixing db prefix
= 1.7.1 =
Fixing submit count on Claims page
February 19th 2017:
= 1.7.0 =
* Adding different claim rules
* Adding update notification even plugin support was disabled
* Adding links to captcha providers
* Adding no captcha option
* Adding better randomizer of claimed prize
* Adding video tutorials
* Adding reinstallation of cron schedule
* Support email has been changed
* Removing faucetbox support
* Minor improvements
February 6th 2017:
= 1.6.2 =
* Fixing issue with epay balance
February 5th 2017:
= 1.6.1 =
* Improving payment log messages
= 1.6.0 =
* Adding real bitcoin address validator
* Adding warning message when “Make payout” button was clicked
* Adding option to set manually threshold for an address
* Adding recaptcha support
* Handling more errors from epay side
= 1.5.5 =
* Adding “Clear scheduled payout” button in claims page
* Disabling “Make payment” button on claims page in case if we have scheduled transactions
* Rescheduling payment for an address in case of network failure (epay.info issue)
= 1.5.4 =
* Displaying error also in case when payment api failed on their side
Version 1.5.3 (January 23rd 2017):
* Adding extra debug information while payout for better issue understanding
Versions 1.5.0 – 1.5.2 (January 22nd 2017):
= 1.5.2 =
* Allowing to schedule payment even wallet wasn’t configured
* Better fee calculation
= 1.5.1 =
* Lazy load of solvemedia captcha
= 1.5.0 =
* Cron run adds stamps to avoid double payment
* Disabling “Make Payment” button when it was clicked to avoid double payment
* Side menu items were reduced
* Adding support fee
* Adding option to opt out of plugin support
Version 1.4.5 – 1.4.8 (January 14th 2017):
* Adding top level navigation
* Adding navigation to “How to use” page
* Moving Claims after Payouts in navigation
* Payments navigation points to Payouts instead of Claims
Version 1.4.4 (January 12th 2017):
* Fixing missed message in support request
* Adding admin email to support request
* Handling error when usage of WP_Http_Curl returns WP_Error
* New short code 1,056,120,871 Satoshis to display paid amount of satoshis “NNN Satoshis”
Version 1.4.3 (January 6th 2017):
* Displaying API keys on wallet page
Version 1.4.2 (January 6th 2017):
* Disabling possibility to refer your own Bitcoin address (double claiming)
version 1.4.1(January 5th 2017):
* Improving error message
version 1.4.0 (January 5th 2017):
* Possibility to set translations for frontend part
* Renaming “Send diagnostic” to “Support”
* Fixing issue when plugins page displays inforrect information about this plugin
Version 1.3.11 (January 4th 2017) :
* Fixing issue with payment failure when using faucethub.io
Version 1.3.10 (December 28th 2016) :
* Adding faucethub.io support
* No way to set epay.info api key if SoapClient extension isn’t installed
* Adding reset option to “tools” page
* Adding “check information” page where you can find related addresses and users
* Adding phpinfo to “send diagnostic”
Version 1.3.9 (December 8th 2016) – Bug fixes
Version 1.3.8 (December 8th 2016) – Bug fixes
Version 1.3.5 (November 23rd 2016) – You can now update the plugin within from with the WP admin area
Version 1.3.4 (November 22nd 2016) – ePay issue fixed, displaying info about payouts on claims page
Version 1.3.3 (November 13th 2016) – DB query bug fix
Version 1.3.2 (November 13th 2016) – Fixing calculation of claims
Version 1.3.1 (November 13th 2016) – Minor text changes and updated user profile page with seniority
Version 1.3.0 (November 12th 2016) – Limited registered users to only one address, added seniority info on claims tab
Version 1.2.7 (November 8th 2016) – Added epay.info as payment option
Version 1.2.6 (November 4th 2016) – Ability to add admin bonuses / penalties, remove ref info if no referral was set
Version 1.2.4 (October 31th 2016) – Bug fixes, added timer and sound
Version 1.2.3 (October 28th 2016) – Bug fixes, fixed issue of payouts display in BTC instead of Satoshi
Version 1.2.1 (October 21th 2016) – Bug fixes
Version 1.2.0 (October 21th 2016) – Added registered user functionality, bot protection
Version 1.1.5 (October 20th 2016) – Bugs fixed, admin tool tips added
Version 1.1.4 (October 10th 2016) – Bugs fixed
Version 1.1.3 (September 29th 2016) – Fixed additional issue with “check address” URL.
Version 1.1.2 (September 26th 2016) – Fixed issue with “check address” URL, can be also a dynamic URL.
Version 1.1.1 (September 12th 2016) – Fixed SolveMedia issue, plugin is now compatible with php 5.2 and up.