Skip to content

Installation Guide

Amin Mahmoudi edited this page Dec 14, 2024 · 17 revisions

πŸ‘‘ What is MasterCryptoFarmBot?

Welcome to the installation guide for the MasterCryptoFarmBot πŸš€.

This software provides a web interface that allows you to install and manage multiple modules to automate your Telegram crypto farm.

πŸ’Ώ Installation Guide

You can install the MasterCryptoFarmBot on Linux, Windows, Android, macOS, and Docker.

  1. πŸ’» Windows Installation
  2. 🐧 Linux Installation
  3. πŸ“± Android Installation
  4. 🍎 macOS Installation
  5. πŸ‹ Docker Installation

πŸ’» Windows Installation

To install the MasterCryptoFarmBot on Windows, follow these steps:

Step 1: Install Python and Git

  1. Install Python 3.x.

    • 🟠 During the installation, ensure you check the box labeled "Add Python to PATH".
    • 🟑 If you forget to add Python to your Windows PATH during installation, you can do it manually afterward. How to add Python to Windows PATH?
    • 🟠 Also, check the box labeled "Install pip".
  2. Install Git.

    • πŸ”΅ (Optional) For a graphical user interface (GUI) for Git on Windows, consider installing TortoiseGit. This step is optional.
    • 🟑 After installation, open a Command Prompt and type git --version to verify the installation. If the command returns a version number, Git has been successfully installed. Otherwise, you need to add Git to your Windows PATH.
    • 🟠 During the installation, ensure you select the option "Use Git from the Windows Command Prompt".
    • 🟑 If you forget to add Git to your Windows PATH during installation, you can do it manually afterward. How to add Git to Windows PATH?

    How to Add Git to Windows PATH Manually

    1. Open the Start Menu and search for "Environment Variables".
    2. Select "Edit the system environment variables".
    3. In the System Properties window, click on the "Environment Variables" button.
    4. In the Environment Variables window, find the "Path" variable in the "System variables" section and select it.
    5. Click on the "Edit" button.
    6. In the Edit Environment Variable window, click on the "New" button and add the path to your Git bin and cmd directories. For example:
    • C:\Program Files\Git\bin
    • C:\Program Files\Git\cmd
    1. Click "OK" to close all windows.
    2. Restart your Command Prompt to apply the changes.

    You have now successfully added Git to your Windows PATH.

Step 2: Clone the Repository

  1. Open the Command Prompt. How to Open Command Prompt.

  2. Navigate to the directory where you want to install the MasterCryptoFarmBot. How to Change Directory in Command Prompt.

  3. Clone the repository:

git clone https://github.com/masterking32/MasterCryptoFarmBot
  1. Navigate to the cloned repository:
cd MasterCryptoFarmBot
  1. Create a new configuration file:
copy config.py.sample config.py
  1. Edit the configuration file:
notepad config.py
  1. Modify the configuration according to your needs:
  1. Run the MasterCryptoFarmBot:
start_windows.cmd

Alternatively, execute the start_windows.cmd file from the File Explorer.

πŸŽ‰ Congratulations! You have successfully installed the MasterCryptoFarmBot on Windows.

Check the following links to learn more about the MasterCryptoFarmBot:

🐧 Linux Installation

To install the MasterCryptoFarmBot on Linux, follow these steps:

Step 1: Install Git and Nano

First, you need to install Git and Nano on your Linux system.

  1. Debian/Ubuntu:

    sudo apt update
    sudo apt install git nano -y
  2. Red Hat/CentOS/AlmaLinux:

    sudo yum update
    sudo yum install git nano -y

Step 2: Clone the Repository

  1. Clone the repository:

    git clone https://github.com/masterking32/MasterCryptoFarmBot
  2. Navigate to the cloned repository:

    cd MasterCryptoFarmBot

Step 3: Create a Configuration File

  1. Create a new configuration file:

    cp config.py.sample config.py
  2. Edit the configuration file:

    nano config.py
  3. Modify the configuration according to your needs:

Step 4: Install Python and Required Packages

We provide a script called start_linux.sh to automate the installation of Python and the required packages. The installation guide will explain how to use this script. If your operating system is not supported by this script, you can manually install Python and the required packages.

This script functions as an installer, restarter, and updater for MasterCryptoFarmBot. It will install all necessary packages and start the bot. If you opt not to use this script, you will need to manually install the required packages and use an alternative method to restart the bot.

Automated Installation

  1. Run the script:

    ./start_linux.sh

After running the script for the first time, it will start installing Python and the required packages, then it will start the bot.

πŸŽ‰ Congratulations! You have successfully installed the MasterCryptoFarmBot on Linux.

Check the following links to learn more about the MasterCryptoFarmBot:

Step 5: Run as a Service

If you have completed the installation and want to run the bot as a service, you can create a systemd service.

  1. Create a new service file:

    sudo nano /etc/systemd/system/mastercryptofarmbot.service
  2. Add the following content:

     [Unit]
     Description=MasterCryptoFarmBot Service
     Documentation=https://github.com/masterking32/MasterCryptoFarmBot
     After=network.target
    
     [Service]
     User=your_username
     WorkingDirectory=/path/to/MasterCryptoFarmBot
     ExecStart=/path/to/MasterCryptoFarmBot/start_linux.sh
     Restart=always
     RestartSec=3
     KillSignal=SIGQUIT
    
     [Install]
     WantedBy=multi-user.target
    • Replace your_username with your Linux username.
    • Replace /path/to/MasterCryptoFarmBot with the path to the MasterCryptoFarmBot directory.
    • You can get your current path using pwd command, by using pwd inside your MasterCryptoFarmBot directory.
    • Save the file by pressing Ctrl + O and then press Enter. Exit the editor by pressing Ctrl + X.
  3. Reload the systemd manager configuration:

    • Ubuntu/Debian:
    sudo systemctl daemon-reload
    • Red Hat/CentOS/AlmaLinux:
    sudo systemctl daemon-reload
  4. Start the service:

    • Ubuntu/Debian:
    sudo systemctl start mastercryptofarmbot
    • Red Hat/CentOS/AlmaLinux:
    sudo systemctl start mastercryptofarmbot
  5. Enable the service to start on boot:

    • Ubuntu/Debian:
    sudo systemctl enable mastercryptofarmbot
    • Red Hat/CentOS/AlmaLinux:
    sudo systemctl enable mastercryptofarmbot
  6. Check the service status:

    • Ubuntu/Debian:
    sudo systemctl status mastercryptofarmbot
    • Red Hat/CentOS/AlmaLinux:
    sudo systemctl status mastercryptofarmbot

πŸ“± Android Installation

If you want to install the MasterCryptoFarmBot on your Android device, you need to install the Termux app on your Android device. Termux is an Android terminal emulator and Linux environment app that works directly with no rooting or setup required.

Step 1: Install a Linux Environment on Android

There are a few ways to install a Linux environment on Android, but the most popular way is to install Termux.

Download and Install Termux

There are two ways to install Termux on your Android device:

  1. Google Play Store:

  2. F-Droid:

  3. GitHub:

For more information, visit the Termux website.

Step 2: Install Git and Nano

  1. Update the package list:

    pkg update
    pkg upgrade -y
  2. Install Git and Nano:

    pkg install git nano -y

Step 3: Clone the Repository

  1. Clone the repository:

    git clone https://github.com/masterking32/MasterCryptoFarmBot
  2. Navigate to the cloned repository:

    cd MasterCryptoFarmBot

Step 4: Create a Configuration File

  1. Create a new configuration file:

    cp config.py.sample config.py
  2. Edit the configuration file:

    nano config.py
  3. Modify the configuration according to your needs:

Step 5: Install Python and Required Packages

We provide a script called start_android.sh to automate the installation of Python and the required packages. The installation guide will explain how to use this script. If your operating system is not supported by this script, you can manually install Python and the required packages.

This script functions as an installer, restarter, and updater for MasterCryptoFarmBot. It will install all necessary packages and start the bot. If you opt not to use this script, you will need to manually install the required packages and use an alternative method to restart the bot.

Automated Installation

  1. Run the script:

    ./start_linux.sh

After running the script for the first time, it will start installing Python and the required packages, then it will start the bot.

πŸŽ‰ Congratulations! You have successfully installed the MasterCryptoFarmBot on Android.

Check the following links to learn more about the MasterCryptoFarmBot:

🍎 macOS Installation

To install the MasterCryptoFarmBot on macOS, follow these steps:

You can run the project on macOS using the same steps as Linux. You can follow the Linux Installation Guide to install the MasterCryptoFarmBot on macOS.

πŸ‹ Docker Installation

To install the MasterCryptoFarmBot using Docker, follow these steps:

Step 1: Install Docker

  1. Install Docker:

  2. Download the Docker folder:

    Download the Docker folder from the MasterCryptoFarmBot repository.

Step 2: Set Up the Docker Environment

Create a .env file with no name and put it in the Docker folder you just downloaded. Open the docker-compose.yml file for instructions on what to add to the .env file.

Step 3: Build and Run the Docker Container

  1. Build the Docker container:

    docker-compose build && docker-compose up -d