-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(readme): updated to m4b v4 instructions with legacy v3 sections
- Loading branch information
Showing
2 changed files
with
235 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,124 +1,294 @@ | ||
| # Money4Band | ||
| <img src="./.resources/.assets/M4B_logo_small.png?raw=true" width="96"> - **Leave a star ⭐ if you like this project 🙂 thank you.** | ||
|
|
||
| **|Easy automatic multi app passive income project with Webdasboard, Auto Updater and Proxy Support :dollar::satisfied::+1:|** | ||
| # Money4Band | ||
|
|
||
| <img src="./.resources/.assets/M4B_logo_small.png?raw=true" width="96"> - **Leave a star ⭐ if you like this project 🙂 thank you.** | ||
|
|
||
|
|
||
|
|
||
| **|Easy automatic multi-app passive income project with Web Dashboard, Auto Updater, and Proxy Support :dollar::satisfied::+1:|** | ||
|
|
||
|
|
||
|
|
||
| ## Quick Overview 🚀 | ||
| **Money4Band** leverages unused internet bandwidth allowing you to make money with something you have and would otherwise be wasted.** It utilizes containerized version of apps like EarnApp, Honeygain, IPRoyal Pawns, PacketStream, Peer2Profit, Repocket, Earnfm, Proxyrack, Proxylite, Bitping and so on but it's also safer than installing and using these native apps on your host system. | ||
|
|
||
| **Money4Band** leverages unused internet bandwidth, allowing you to make money with something you have and would otherwise be wasted. It utilizes containerized versions of apps like EarnApp, Honeygain, IPRoyal Pawns, PacketStream, Peer2Profit, Repocket, Earnfm, Proxyrack, Proxylite, Bitping, and more. It's also safer than installing and using these native apps on your host system. | ||
|
|
||
|
|
||
|
|
||
| ✨ **Key Features:** | ||
| - **Multiplatform** and lightweight docker stack. | ||
| - **Automatic Updates** to keep your applications up-to-date. | ||
| - **Web Dashboard** for easy monitoring. | ||
| - **Proxy Support** for enhanced flexibility. | ||
|
|
||
| - **Multiplatform** and lightweight Docker stack. | ||
|
|
||
| - **Automatic Updates** to keep your applications up-to-date. | ||
|
|
||
| - **Web Dashboard** for easy monitoring. | ||
|
|
||
| - **Proxy Support** for enhanced flexibility. | ||
|
|
||
|
|
||
|
|
||
| 🌐 For a detailed overview and FAQ, visit the [Wiki](https://github.com/MRColorR/money4band/wiki) or join our [Discord Community](#-join-the-money4band-community-on-discord). | ||
|
|
||
|
|
||
|
|
||
| ## Getting Started 🚥 | ||
|
|
||
|
|
||
|
|
||
| ### Prerequisites | ||
| - Ensure that you have a 64-bit operating system, virtualization functions are enabled and Docker is installed and able to auto start up on system boot. | ||
| - (Optional) For ARM devices like Raspberry Pi, installing an emulation layer for non-ARM native Docker images is recommended. Even though the script can assist with the installation, we recommend users to install an emulation layer by themselves following the [Wiki](https://github.com/MRColorR/money4band/wiki) guide. | ||
| - (Optional) On Windows, ensure the Virtualization platform and Windows Subsystem for Linux are active as Docker requires these features. Even though the script can assist with the installation, we recommend users to enable these windows functions by themselves following the [Wiki](https://github.com/MRColorR/money4band/wiki) guide. | ||
|
|
||
| - Ensure that you have a 64-bit operating system, virtualization functions are enabled, and Docker is installed and able to auto-start on system boot. | ||
|
|
||
| - (Optional) For ARM devices like Raspberry Pi, installing an emulation layer for non-ARM native Docker images is recommended. Even though the script can assist with the installation, we recommend users install an emulation layer by themselves following the [Wiki](https://github.com/MRColorR/money4band/wiki) guide. | ||
|
|
||
| - (Optional) On Windows, ensure the Virtualization Platform and Windows Subsystem for Linux are active as Docker requires these features. Even though the script can assist with the installation, we recommend users enable these Windows functions by themselves following the [Wiki](https://github.com/MRColorR/money4band/wiki) guide. | ||
|
|
||
|
|
||
|
|
||
| ### Quick Setup Guide | ||
| 1. **Download** the latest version of Money4Band from the [Releases](https://github.com/MRColorR/money4band/releases) or git clone the project. | ||
| - OR you can also use on Linux/MacOS a bash command like: `wget https://github.com/MRColorR/money4band/archive/refs/heads/main.zip && unzip main.zip` | ||
| - OR on Windows use a pwsh command like:`Invoke-WebRequest -Uri https://github.com/MRColorR/money4band/archive/refs/heads/main.zip -OutFile main.zip; Expand-Archive -Path main.zip -DestinationPath .\ ` | ||
| 3. **Register** accounts on the application websites. [Here's a list of availabe apps](#app-compatibility-and-sign-up-links-) | ||
| 4. **Run** the guided setup: | ||
| - **Linux:** | ||
| ```bash | ||
| sudo chmod +x runme.sh && ./runme.sh | ||
| ``` | ||
| - **Windows:** | ||
| ```powershell | ||
| Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass -Force; .\runme.ps1 | ||
| ``` | ||
| 5. **Start Earning** passively and monitor your performance through the web dashboard. | ||
|
|
||
|
|
||
|
|
||
| #### Preferred Method: Using Release Artifacts | ||
|
|
||
|
|
||
|
|
||
| 1. **Download** the latest release of Money4Band for your operating system from the [Releases Page](https://github.com/MRColorR/money4band/releases). | ||
|
|
||
| - **Windows Users:** | ||
|
|
||
| - Download the `Money4Band-windows-latest-x64-<version>.zip` file. | ||
|
|
||
| - Extract the ZIP file to a folder of your choice. | ||
|
|
||
| - Navigate to the extracted folder and run `money4band.exe`. | ||
|
|
||
| - **Note:** If Windows SmartScreen appears, click on **More info** and then select **Run anyway** to proceed. | ||
|
|
||
| - **Linux Users:** | ||
|
|
||
| - Download the `Money4Band-ubuntu-latest-x64-<version>.tar.gz` file. | ||
|
|
||
| - Extract the tar.gz file:```tar -xvzf Money4Band-ubuntu-latest-x64-<version>.tar.gz``` | ||
|
|
||
| - Navigate to the extracted folder and run the script:```./money4bandchmod +x money4band``` | ||
| - **Note:** You can make sure it is executable on your OS with ```chmod +x money4band``` | ||
|
|
||
| - **macOS Users:** | ||
|
|
||
| - Download the `Money4Band-macos-latest-x64-<version>.tar.gz` file. | ||
|
|
||
| - Extract the tar.gz file:```tar -xvzf Money4Band-macos-latest-x64-<version>.tar.gz``` | ||
|
|
||
| - Navigate to the extracted folder and run the script:```./money4bandchmod +x money4band``` | ||
| - **Note:** You can make sure it is executable on your OS with ```chmod +x money4band``` | ||
|
|
||
| - **ARM Devices (e.g., Raspberry Pi):** | ||
|
|
||
| - Download the appropriate ARM release from the [Releases Page](https://github.com/MRColorR/money4band/releases) (e.g., `arm64` or `armv7`). | ||
|
|
||
| - Follow the same steps as Linux users. | ||
|
|
||
|
|
||
|
|
||
| 2. **Register** accounts on the application websites. [Here's a list of available apps](#app-compatibility-and-sign-up-links-). | ||
|
|
||
|
|
||
|
|
||
| 3. **Run** the guided setup through the Money4Band application: | ||
|
|
||
| - Follow the on-screen instructions to configure and start the services. | ||
|
|
||
|
|
||
|
|
||
| 4. **Start Earning** passively and monitor your performance through the web dashboard. | ||
|
|
||
|
|
||
|
|
||
| #### Alternative Method: Cloning the Repository | ||
|
|
||
|
|
||
|
|
||
| If you prefer to clone the repository or contribute to the project: | ||
|
|
||
|
|
||
|
|
||
| 1. **Clone** the project:```git clone https://github.com/MRColorR/money4band.git && cd money4band``` | ||
|
|
||
| - **OR** download the ZIP and extract it using one of the options below: | ||
| - ```wget https://github.com/MRColorR/money4band/archive/refs/heads/main.zip && unzip main.zip && cd money4band-main``` | ||
| - ```Invoke-WebRequest -Uri https://github.com/MRColorR/money4band/archive/refs/heads/main.zip -OutFile main.zip; Expand-Archive -Path main.zip -DestinationPath .\ ; cd money4band*``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ### M4B v3 legacy Setup Guide | ||
|
|
||
| 1. **Download** the latest version of Money4Band from the [Releases](https://github.com/MRColorR/money4band/releases) or git clone the project. | ||
| 2. **Register** accounts on the application websites. [Here's a list of availabe apps](#app-compatibility-and-sign-up-links-) | ||
| 3. **Access the Money4Band v3 Folder**: The legacy code of M4B v3 is included with the new releases and is located in a subfolder. To run the old M4B v3 bash or PowerShell scripts, navigate to this subfolder and use one of the following options: | ||
| - **(Linux/Mac):** ```sudo chmod +x runme.sh && ./runme.sh``` | ||
| - **(Windows):**```Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass -Force; .\runme.ps1``` | ||
|
|
||
|
|
||
| 4. **Follow the remaining standard steps until completion** | ||
|
|
||
|
|
||
|
|
||
| ## App Compatibility and Sign Up Links 📋 | ||
|
|
||
| Register an account on the app's sites clicking each apps' names in the following compatibility matrix | ||
|
|
||
| - :moneybag: Registering trough these links on the apps' sites, you should also receive a welcome bonus and at the same time you will effortlessly show that you appreciate my work, thank you so much :slightly_smiling_face:. | ||
|
|
||
|
|
||
| - :moneybag: Registering trough these links on the apps' sites, you should also receive a welcome bonus and at the same time you will effortlessly show that you appreciate my work, thank you so much :slightly_smiling_face:. | ||
|
|
||
|
|
||
|
|
||
| - :key: If you are using login with google, remember to set also a password for your app account! | ||
|
|
||
| | App Name & Link | Residential/Home/Mobile IP or equivalent Proxy's IP | VPS/Datacenter/Hosting/Cloud IP or equivalent Proxy's IP | Max devices per Account | Max Devices per IP | | ||
| | :--- | :---: | :---: | :---: | :---: | | ||
| | Go to [Earnapp](https://earnapp.com/i/3zulx7k) | :white_check_mark: | :x: | 15|1| | ||
| | Go to [HoneyGain](https://r.honeygain.me/MINDL15721) | :white_check_mark: | :x: |10|1| | ||
| | Go to [IPROYAL](https://pawns.app?r=MiNe) | :white_check_mark: | :x: |Unlimited|1| | ||
| | Go to [PEER2PROFIT](https://t.me/peer2profit_app_bot?start=165849012262da8d0aa13c8) | :white_check_mark: | :white_check_mark: | Unlimited|Unlimited| | ||
| | Go to [PACKETSTREAM](https://packetstream.io/?psr=3zSD) | :white_check_mark: | :x: |Unlimited|1| | ||
| | Go to [TRAFFMONETIZER](https://traffmonetizer.com/?aff=366499) | :white_check_mark: | :white_check_mark: |Unlimited|Unlimited| | ||
| | Go to [REPOCKET](https://link.repocket.co/hr8i) | :white_check_mark: | :white_check_mark: |Unlimited|2| | ||
| | Go to [EARNFM](https://earn.fm/ref/MATTTAV6) | :white_check_mark: | :x: |Unlimited|1| | ||
| | Go to [PROXYRACK](https://peer.proxyrack.com/ref/myoas6qttvhuvkzh8ffx90ns1ouhwgilfgamo5ex) | :white_check_mark: | :white_check_mark: |500|1| | ||
| | Go to [PROXYLITE](https://proxylite.ru/?r=PJTKXWN3) | :white_check_mark: | :white_check_mark: |Unlimited|1| | ||
| | Go to [BITPING](https://app.bitping.com?r=qm7mIuX3) | :white_check_mark: | :white_check_mark: |Unlimited|1| | ||
|
|
||
|
|
||
| | App Name & Link | Residential/Home/Mobile IP or equivalent Proxy's IP | VPS/Datacenter/Hosting/Cloud IP or equivalent Proxy's IP | Max devices per Account | Max Devices per IP | | ||
|
|
||
| | :--- | :---: | :---: | :---: | :---: | | ||
|
|
||
| | Go to [Earnapp](https://earnapp.com/i/3zulx7k) | :white_check_mark: | :x: | 15|1| | ||
|
|
||
| | Go to [HoneyGain](https://r.honeygain.me/MINDL15721) | :white_check_mark: | :x: |10|1| | ||
|
|
||
| | Go to [IPROYAL](https://pawns.app?r=MiNe) | :white_check_mark: | :x: |Unlimited|1| | ||
|
|
||
| | Go to [PEER2PROFIT](https://t.me/peer2profit_app_bot?start=165849012262da8d0aa13c8) | :white_check_mark: | :white_check_mark: | Unlimited|Unlimited| | ||
|
|
||
| | Go to [PACKETSTREAM](https://packetstream.io/?psr=3zSD) | :white_check_mark: | :x: |Unlimited|1| | ||
|
|
||
| | Go to [TRAFFMONETIZER](https://traffmonetizer.com/?aff=366499) | :white_check_mark: | :white_check_mark: |Unlimited|Unlimited| | ||
|
|
||
| | Go to [REPOCKET](https://link.repocket.co/hr8i) | :white_check_mark: | :white_check_mark: |Unlimited|2| | ||
|
|
||
| | Go to [EARNFM](https://earn.fm/ref/MATTTAV6) | :white_check_mark: | :x: |Unlimited|1| | ||
|
|
||
| | Go to [PROXYRACK](https://peer.proxyrack.com/ref/myoas6qttvhuvkzh8ffx90ns1ouhwgilfgamo5ex) | :white_check_mark: | :white_check_mark: |500|1| | ||
|
|
||
| | Go to [PROXYLITE](https://proxylite.ru/?r=PJTKXWN3) | :white_check_mark: | :white_check_mark: |Unlimited|1| | ||
|
|
||
| | Go to [BITPING](https://app.bitping.com?r=qm7mIuX3) | :white_check_mark: | :white_check_mark: |Unlimited|1| | ||
|
|
||
| | Go to [SPEEDSHARE](https://speedshare.app/?ref=mindlessnerd) | :white_check_mark: | :x: | Unlimited | 1 | | ||
|
|
||
| | Go to [GRASS](https://app.getgrass.io/register/?referralCode=qyvJmxgNUhcLo2f) | :white_check_mark: | :x: | Unlimited | 1 | | ||
| | Go to [MYSTNODE](https://mystnodes.co/?referral_code=Tc7RaS7Fm12K3Xun6mlU9q9hbnjojjl9aRBW8ZA9) | :white_check_mark: | :white_check_mark: |Unlimited|Unlimited| | ||
|
|
||
| | Go to [MYSTNODE](https://mystnodes.co/?referral_code=Tc7RaS7Fm12K3Xun6mlU9q9hbnjojjl9aRBW8ZA9) | :white_check_mark: | :white_check_mark: |Unlimited|Unlimited| | ||
|
|
||
|
|
||
|
|
||
| ## Scale Up with Multi-Proxy Support 🌐 | ||
|
|
||
|
|
||
|
|
||
| **Money4Band** has the ability to create multiple instances also using a proxy list, ideal for scaling up your setup. Quickly set up numerous instances each linked to a different proxy with ease. | ||
|
|
||
|
|
||
|
|
||
| ### Getting Started with Multi-Proxy | ||
| - **Initial Setup**: First, set up the main instance using `runme.sh` with a proxy. | ||
| - **Prepare Proxies**: Create a `proxies.txt` in the root folder, listing each remaning proxy on a separate line and ending with a new line. | ||
|
|
||
| ### Launching Multiple Instances | ||
| 1. **Run the Script**: Use the "Setup and manage multiproxy instances by list" in the M4B menu or execute `runmproxies` script in the terminal. This script intelligently handles existing instances by offering to: | ||
| - Clear and recreate all instances. | ||
| - Update proxies for existing setups (if sufficient proxies are available). | ||
| - Exit without changes. | ||
| 1. **Prepare Proxies**: Create a `proxies.txt` file in the root folder of M4B, listing each proxy on a separate line and ending with a new line. | ||
| 2. **Start M4B and do the Setup**: During the setup Money4Band will ask you if you want to setup mutiplroxy, reply yes and follow the steps. | ||
|
|
||
| 2. **Automated Setup**: For each proxy in `proxies.txt`, the script sets up a new instance with appropriate configurations. | ||
| ### Getting Started with Multi-Proxy (Legacy M4B v3) | ||
| 1. **Initial Setup**: First, set up the main instance using `runme.sh` with a proxy. | ||
| 2. **Prepare Proxies**: Create a `proxies.txt` in the root folder, listing each remaning proxy on a separate line and ending with a new line. | ||
| 3. **Run the multiproxy instances**: Use the "Setup and manage multiproxy instances by list" in the M4B menu or execute `runmproxies` script in the terminal. | ||
|
|
||
| > **Notice**: While using multiple proxies, be aware that only certain apps permit proxy usage per their ToS. We recommend using personal, private proxies with IPs not flagged as proxies and always respecting the ToS of each app. | ||
| > **Notice:** While using multiple proxies, be aware that only certain apps permit proxy usage per their Terms of Service. We recommend using personal, private proxies with IPs not flagged as proxies and always respecting the ToS of each app. | ||
|
|
||
|
|
||
| ## Compatibility and tested environments | ||
| This Docker Stack should work on anything that may have docker installed. In particular, it has been tested on: | ||
| | | Windows 11 x86_64\amd64 | Linux Ubuntu x86_64\amd64 | Raspbian OS arm64 | MacOS Intel x86_64 | MacOS silicon arm64 | | ||
| | :---: | :---: | :---: | :---: | :---: | :---: | | ||
|
|
||
| This Docker Stack should work on anything that may have docker installed. In particular, it has been tested on: | ||
|
|
||
| | | Windows 11 x86_64\amd64 | Linux Ubuntu x86_64\amd64 | Raspbian OS arm64 | MacOS Intel x86_64 | MacOS silicon arm64 | | ||
|
|
||
| | :---: | :---: | :---: | :---: | :---: | :---: | | ||
|
|
||
| | Tested | :green_circle: | :green_circle: | :green_circle: | :green_circle: | :green_circle:| | ||
|
|
||
| | on device | Desktop/Laptop PC | Desktop/Laptop PC | Raspberry Pi3/Pi4 | MacBook Pro | MacBook Air | | ||
|
|
||
|
|
||
|
|
||
| :green_circle:: All functions supported, Auto/manual setup supported | ||
|
|
||
| :yellow_circle:: All functions supported but not tested, Auto/manual setup supported | ||
|
|
||
|
|
||
|
|
||
| ## Need Help or Found an Issue? ❓ | ||
|
|
||
| - For discussions, info, and feature requests, use the [Discussion tab](https://github.com/MRColorR/money4band/discussions) or join our [Discord Community](#-join-the-money4band-community-on-discord). | ||
|
|
||
| - F.A.Q., Alternatve Manual Setup, How To Update, other useful guides and more details inside the [Wiki](https://github.com/MRColorR/money4band/wiki) | ||
|
|
||
|
|
||
|
|
||
| - For issues and bug reporting, use the [Issue tab](https://github.com/MRColorR/money4band/issues). | ||
|
|
||
| ## 🚀 Join the Money4Band Community on Discord! | ||
| We've launched a Discord server! It's a space for you to share your experiences, ask questions, and discuss everything related to Money4Band and its related projects like custom docker images created for M4B and so on. | ||
|
|
||
|
|
||
| ## 🚀 Join the Money4Band Community on Discord! | ||
|
|
||
| Join our Discord server! It's a space for you to share your experiences, ask questions, and discuss everything related to Money4Band and its related projects like custom docker images created for M4B and so on. | ||
|
|
||
| [Join the Money4Band Discord Community](https://discord.com/invite/Fq8eeazBAD) | ||
|
|
||
|
|
||
|
|
||
| ## Support the Projects 🫶 | ||
|
|
||
|
|
||
|
|
||
| Your contributions are vital in helping to sustain the development of open-source projects and tools made freely available to everyone. If you find value in my work and wish to show your support, kindly consider making a donation: | ||
|
|
||
|
|
||
|
|
||
| ### Cryptocurrency Wallets | ||
|
|
||
| - **Bitcoin (BTC):** `1EzBrKjKyXzxydSUNagAP8XLeRzBTxfHcg` | ||
| - **Ethereum (ETH):** `0xE65c32004b968cd1b4084bC3484C0dA051eeD3ee` | ||
| - **Solana (SOL):** `6kUAWW8q5169qnUJdxxLsNMPpaKPvbUSmryKDYTb9epn` | ||
| - **Polygon (MATIC):** `0xE65c32004b968cd1b4084bC3484C0dA051eeD3ee` | ||
| - **BNB (Binance Smart Chain):** `0xE65c32004b968cd1b4084bC3484C0dA051eeD3ee` | ||
|
|
||
|
|
||
| - **Bitcoin (BTC):** `1EzBrKjKyXzxydSUNagAP8XLeRzBTxfHcg` | ||
|
|
||
| - **Ethereum (ETH):** `0xE65c32004b968cd1b4084bC3484C0dA051eeD3ee` | ||
|
|
||
| - **Solana (SOL):** `6kUAWW8q5169qnUJdxxLsNMPpaKPvbUSmryKDYTb9epn` | ||
|
|
||
| - **Polygon (MATIC):** `0xE65c32004b968cd1b4084bC3484C0dA051eeD3ee` | ||
|
|
||
| - **BNB (Binance Smart Chain):** `0xE65c32004b968cd1b4084bC3484C0dA051eeD3ee` | ||
|
|
||
|
|
||
|
|
||
| Your support, no matter how small, is enormously appreciated and directly fuels ongoing and future developments. Thank you for your generosity! 🙏 | ||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| ### :warning: Disclaimer | ||
| Always check that the laws of your country and the contractual terms of your internet plan allow the use of such applications. In any case, I do not take any responsibility for any consequences deriving from the use of such apps. This stack proposed by me simply brings these apps together, allows easy configuration even for the less experienced and updates the apps' images automatically. | ||
| This project and its artifacts are provided "as is" and without warranty of any kind. | ||
| The author makes no warranties, express or implied, that this script is free of errors, defects, or suitable for any particular purpose. | ||
| The author shall not be retained liable for any damages suffered by any user of this script, whether direct, indirect, incidental, consequential, or special, arising from the use of or inability to use this script or its documentation, even if the author has been advised of the possibility of such damages. | ||
|
|
||
|
|
||
| Always check that the laws of your country and the contractual terms of your internet plan allow the use of such applications. In any case, I do not take any responsibility for any consequences deriving from the use of such apps. This stack proposed by me simply brings these apps together, allows easy configuration even for the less experienced, and updates the apps' images automatically. | ||
|
|
||
| This project and its artifacts are provided "as is" and without warranty of any kind. | ||
|
|
||
| The author makes no warranties, express or implied, that this script is free of errors, defects, or suitable for any particular purpose. | ||
|
|
||
| The author shall not be held liable for any damages suffered by any user of this script, whether direct, indirect, incidental, consequential, or special, arising from the use of or inability to use this script or its documentation, even if the author has been advised of the possibility of such damages. | ||
|
|
||
|
|
||
|
|
||
| ## :hash: License | ||
| [GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.html) | ||
|
|
||
| [GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters