earnfm/fleetshare repository overview

⁠Fleetshare Docker Setup Guide

This guide will walk you through setting up the Fleetshare client using Docker. Fleetshare is particularly effective if you have multiple proxies or static IP addresses routed to your server. This setup includes Watchtower to keep your client automatically updated.

⁠Prerequisites

1. Docker: Docker must be installed on your machine. If not, follow the official installation guide: Install Docker⁠.
2. Earn.fm Account & API Key: You need an account at https://app.earn.fm⁠. Obtain your API Key from the settings page within the app.
3. Proxies/IPs: You should have access to a pool of IP addresses (e.g., 100+ IPs recommended for optimal use) that you own, accessible via SOCKS5 proxies or statically routed to your server.
4. Access to Fleetshare: Ensure you have requested and been granted access to Fleetshare. You can request access here⁠.

⁠Setup Steps

⁠Step 1: Create the Configuration File

Fleetshare uses a config.json file to manage its settings, including your API key and device connections (proxies or subnets).

1. Create a file named config.json in a directory of your choice (e.g., your home directory or a dedicated directory like /opt/fleetshare). You can use a text editor like nano:

   nano config.json
   

   Copy

2. Paste the following JSON structure into the file:

   {
     "apiKey": "YOUR_API_KEY_FROM_APP.EARN.FM",
     "devices": {
       "subnets": ["203.0.113.0/24"],
       "socksProxies": ["user:[email protected]:1080"]
     },
     "debug": false
   }
   

   Copy

3. Important:

   • Replace "YOUR_API_KEY_FROM_APP.EARN.FM" with your actual API key obtained from app.earn.fm.
   • Configure devices:
     • If you have static IPs routed to your server as subnets, list them in the "subnets" array (e.g., ["203.0.113.0/24", "198.51.100.0/24"]). Leave empty [] if unused.
     • If you are using SOCKS5 proxies, list them in the "socksProxies" array using the format "user:password@ip:port" or "ip:port" if no authentication is needed. Leave empty [] if unused.
     • You can use either subnets or socksProxies, or both.
   • Set "debug" to true only if you need detailed logs for troubleshooting; otherwise, keep it false.

4. Save the file and exit the editor (in nano, press CTRL+X, then Y, then Enter).

⁠Step 2: Run Fleetshare and Watchtower

The following single command will stop and remove any previous instances of Fleetshare and Watchtower, pull the latest images (using the correct earnf/fleetshare image name), and then start both containers correctly configured.

Make sure you run this command from the same directory where you saved your config.json file. Copy the entire line below and paste it into your terminal:

sudo docker stop fleetshare-client watchtower; sudo docker rm fleetshare-client watchtower; sudo docker rmi earnfm/fleetshare:latest containrrr/watchtower; sudo docker pull earnfm/fleetshare:latest; sudo docker pull containrrr/watchtower; sudo docker run -d --name fleetshare-client --restart=always --network host -v "$(pwd)/config.json:/app/config.json" earnfm/fleetshare:latest && sudo docker run -d --name watchtower --restart=always -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --cleanup --include-stopped --include-restarting --revive-stopped --interval 60 fleetshare-client

What this command does:

• Stops and removes any old fleetshare-client and watchtower containers and their images to ensure a clean start.
• Pulls the latest versions of the earnf/fleetshare and watchtower images.
• Starts the fleetshare-client container using your config.json, ensuring it restarts automatically and uses the host's network.
• Starts the watchtower container to automatically monitor and update only the fleetshare-client container every 60 seconds.

This setup ensures your Fleetshare client is running with your configuration, automatically restarts on failure, and stays updated to the latest version via Watchtower with minimal manual intervention.

⁠Enjoy earning at scale