Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
106 lines (69 sloc) 5.23 KB

Bitcoin Faucet Rotator - Installation Instructions

First of all, thank you for your interest in this script. I hope you will gain some good use from it :). If you experience any complications installing this script, please let me know - I am willing to help you, and amend these instructions if necessary.

NOTE: To get referral income from the faucets, you will need to replace my referral codes with your own. Your user credentials to log in will have been seeded from the .env file you created in Step 3. You can edit these when you log in to the script.

The steps below outline the instructions needed to install the script.

Installation

At the time of writing these instructions, this script uses Laravel version 5.8.*.

These instructions are for Linux-based servers using Apache 2.4+. If you have servers powered by other operating systems (e.g. Windows, MAC OS, etc.), please let me know, and feel free to contribute installation instructions for said operating system/s.

If you don't currently have a server already, I highly recommend the USD$5/mo package from DigitalOcean. If you choose to sign up through my link, we will both get USD$10 credit :).

If you experience any issues with installation, please log them as issues so others may provide feedback (make sure you anonymise any file paths, passwords, etc). Alternatively, you can contact me through email (details at the bottom of this install.md file). This script has not long been released to the public, so there are bound to be some issues with different setups - which is why your feedback and contributions are very important.

Pre-requisites

Before you begin installing the script, please make sure your server meets the following specifications:

  • PHP >= 7.1.3.
  • BCMath PHP Extension.
  • Ctype PHP Extension.
  • JSON PHP Extension.
  • Mbstring PHP Extension.
  • OpenSSL PHP Extension.
  • PDO PHP Extension.
  • Tokenizer PHP Extension.
  • XML PHP Extension.
  • Enable Mod Rewrite, Mod Headers for Apache

You must also have a database created. Currently, you can use the following for this project:

  • MySQL.
  • PostgreSQL.
  • SQL Server.

Step 1

Navigate to the root directory of your web server, then clone this repository.

For example, I would navigate to '/var/www' and issue the following command:

git clone https://github.com/rattfieldnz/bitcoin-faucet-rotator-v2.git yourdomain.com

Step 2

Make the 'setup' script executable by running the following command: chmod u+x setup-project.

Once you have ran the command above, you may begin installing the project's dependencies by running the following command:

./setup-project

This process can take a few minutes, depending on your server resources and bandwidth speed.

Step 3

If you have a Linux-based server (as I am using), and are using Apache, use the following command to create an Apache sites file for your script:

touch /etc/apache2/sites-available/yourdomain.com.conf 

Once you have created this file, enter the following into it:

<VirtualHost yourdomain.com:80>
    ServerName yourdomain.com
    ServerAdmin webmaster@yourdomain.com
    DocumentRoot "/var/www/yourdomain.com/public"
    <Directory "/var/www/yourdomain.com/public">
        Options Indexes FollowSymLinks MultiViews
        AllowOverride All
        Order allow,deny
        allow from all
    </Directory>
    ErrorLog ${APACHE_LOG_DIR}/error.log
    # Possible values include: debug, info, notice, warn, error, crit,
    # alert, emerg.
    LogLevel warn
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

Once this file has the above in it, execute the following commands to load it into Apache:

a2ensite yourdomain.com.conf && service apache2 reload

NOTE:

If you are running this in a local testing environment, add AccessFileName .htaccess-dev below the DocumentRoot line above. I have encountered authentication issues (e.g. not being able to log in) due to settings in the main .htaccess file, and have found that only having the default .htaccess in my local testing environment removes the issues I was having. I plan on using a process of elimination to see what exact .htaccess setting are causing the issues, and will report my findings here.

Step 4

Now the necessary pre-requisites have been completed, visit yourdomain.com/install in your browser. If the previous steps were successful, you can now follow the steps in that installation process.

Barring any potential errors in the previous installation, the script should be successful installed. Visit yourdomain.com in a (modern) web browser to see the functioning script in action.


Notes

If you encounter any errors during installation, please let me know by emailing me at emailme[AT]robertattfield[DOT]com. Eventually, I will like the installation process to be simpler, so having many users with different hosting platforms and requirements will improve this.

You can’t perform that action at this time.