Income Generator

[ Multi-Platform | Docker Stack | Containerized | Passive Income | Auto Update ]

If you like this project, don't forget to leave a star. ⭐

NOTE: "This tool has always been developed for my personal use in mind, therefore the focus has always been Linux first as I run them on my home and cloud servers before making it available to the general public."

Overview 📚

Income Generator is an all-in-one tool that consolidates a variety of supported applications, enabling the ability to generate passive income by leveraging everyday devices and unused internet bandwidth.

By seamlessly integrating these applications, simplifying the entire process, making it more efficient and accessible with applications auto-updating.

Some of the key features you can expect:

• Easy To Use - All-in-one solution for managing the stack. Docker installation, start/stop/remove.
• Multi-platform - Deploy across different OS.
• Global Access - Access the tool anywhere, just type igm.
• Auto update - Ensures applications always running up-to-date.
• On-the-fly-update - Tool can be updated on the fly whilst preserving config settings.
• Local Config - Config file is auto-generated and stored locally, including credentials.
• Resource Limit - Easily apply resource limit based on system hardware.

📖 Referring to the Wiki is strongly recommended for more details and in-depth instructions.

Getting Started 🚥

Prerequisite 📦

The tool configures and runs everything in a containerised virtualised environment isolated from the host.

• Works best on a 64-bit machine, though it is still possible to run it under a 32-bit operating system (OS), but will will come with certain performance limitations, specifically with lower memory availability.
• A minimum of 4GB would be best recommended to ensure the most resource available and for future expansions.
• The stack requires a more recent version of Docker which bundles Compose for orchestrating and running containers.
• For ARM architecture devices, such as Raspberry Pi, Apple Silicon etc, will be required to install an emulation layer such as qemu-user-static (qus) to run x86 architecture on ARM. This can be easily enabled via the Docker container which injects it directly.
• For Windows, WSL2 and Winget will be required.

Check the Prerequisites section for emulation layer setup.

Quick Start Guide ⚙️

Assuming Docker and Compose is already pre-installed (Can also be installed from the tool):

:warning: Newer versions of Docker integrate Compose directly. Accessed as docker compose instead of docker-compose.

Windows

Refer to the Windows guide first to ensure prerequisites are met before proceeding. If WSL is already configured, continue.

Open the command line (Run as administrator this one time) and get the bootstrap script.

curl -o %windir%\igm.bat --ssl-no-revoke -L https://raw.githubusercontent.com/XternA/income-generator/main/start.bat

Run the tool.

# Type anywhere in the command line
igm

Linux & macOS

Open the terminal and clone the project.

git clone --depth=1 https://github.com/XternA/income-generator.git ~/.income-generator

Register alias for global access. (Auto detects and adds to current shell choice e.g. .bashrc, .zshrc etc.)

echo "alias igm='(cd ~/.income-generator; sh start.sh)'" >> ~/."${SHELL##*/}"rc; source ~/."${SHELL##*/}"rc

Run the tool.

# Type anywhere in the command line
igm

Register Applications

Register an account for each application in the applications table. Can also be done from the tool.

App Compatibility 📋

Using the table below, each app can identify its total install count per IP type. This indicates which stack option to run in the 'Install & Run Applications' option of the tool.

Each app has been grouped in the install option. Therefore, whether it be residential or hosting already installed in the same network, you can install it on another device within the same network using the selective choice. The tool will install all the apps that meet the conditions below.

• 📋 Register via the links below will entitle you to receive a bonus added to your account on registration. Additionally, it ensures you're registering at the correct site and showing your support for my work.
• 🔐 If using social logins such as Google, be sure to set a password to the account as it will be required for authentication to the app later.

Tested Environments ✅

The docker stack should work on anything that may have docker installed. In particular, it has been tested on:

:green_circle: - Everything supported, tried and tested.

:yellow_circle: - Almost everything is supported. Only minor things which may not be fully supported.

:orange_circle: - Orchestrating applications and docker stack should work, but not everything is intended for full support.

Note that working means within the tool when you run and interact with it.

Like The Project? 🫶

Your efforts and interest are well appreciated if you would like to contribute and improve the tool or compatibility and enable it widely available and easy to use.

Even if you do not wish to contribute, you can still show your support by giving this project a star ⭐.

Donations 💸

• Bitcoin (BTC) - bc1qq993w3mxsf5aph5c362wjv3zaegk37tcvw7rl4
• Ethereum (ETH) - 0x2601B9940F9594810DEDC44015491f0f9D6Dd1cA
• Binance (BNB) - bnb1dj3l3fp24z05vtwtjpaatjyz9sll4elu9lkjww
• Binance Smart Chain (BSC) - 0x2601B9940F9594810DEDC44015491f0f9D6Dd1cA
• Solana (SOL) - Ap5aiAbnsLtR2XVJB3sp37qdNP5VfqydAgUThvdEiL5i
• PayPal - @xterna

Donations are warmly welcomed, no matter the amount, your support is gratefully appreciated. Additionally, it helps fuel future developments and maintenance. Thank you. 🙏🏻

:warning: Disclaimer

Before using the applications provided in this stack, it is essential to verify that your actions comply with the laws of your jurisdiction and adhere to the terms outlined in your internet service provider's contract. The integration of these applications within this stack is purely for user convenience and does not signify an endorsement of their utilization.

The author of this stack does not accept any responsibility for the outcomes resulting from the utilization of these applications. While this stack streamlines the configuration process and facilitates automated updates for the included applications, it is distributed on an "as is" basis without any warranties.

The author does not provide any assurances, whether explicit or implicit, regarding the accuracy, completeness, or appropriateness of this script for specific purposes. The author shall not be held accountable for any damages, including but not limited to direct, indirect, incidental, consequential, or special damages, arising from the use or inability to use this tool or its accompanying documentation, even if the possibility of such damages has been communicated.

By choosing to utilize this tool, you acknowledge and assume all risks associated with its use. Additionally, you agree that the author cannot be held liable for any issues or consequences that may arise as a result of its usage.