Installation & Setup#

#Installation on Linux PC

Braiins Farm Proxy has its own public Github repository and it is basically a stack of 4 Docker containers. You can easily install it with the Linux terminal of the hardware which will host the proxy.

At the beginning it is required to install a couple of prerequisites:

#Verify Prerequisites Installed

docker version
docker compose version
git --version

#Download Braiins Farm Proxy Repository

git clone https://github.com/braiins/farm-proxy.git

Docker stack consists of following containers:

• farm-proxy: container with the Braiins Farm Proxy binary
• farm-proxy-gui: container with GUI for updating the Farm Proxy configuration on the fly
• farm-proxy-configurator: container pushing the updated configuration to Farm Proxy container
• grafana: container with Grafana application
• prometheus: container with the Prometheus database

#Installation on Raspberry Pi

Braiins Farm Proxy has its own public Github repository and it is basically a stack of 5 Docker containers. You can easily install it with the Linux terminal of the hardware which will host the proxy.

At the beginning it is required to install a couple of prerequisites:

#Verify Prerequisites Installed

docker version
docker compose version
git --version

#Download Braiins Farm Proxy Repository

git clone https://github.com/braiins/farm-proxy.git

Docker stack consists of following containers:

• farm-proxy: container with the Braiins Farm Proxy binary
• farm-proxy-gui: container with GUI for updating the Farm Proxy configuration on the fly
• farm-proxy-configurator: container pushing the updated configuration to Farm Proxy container
• grafana: container with Grafana application
• prometheus: container with the Prometheus database

#Farm Proxy set up

Start

When the mining operation with usage of Braiins Farm Proxy is configured by the farm operator, the proxy can get started (configuration itself is described in detail in Configuration section). Run the command in the Linux terminal docker compose up -d. To see if all the Docker containers are running, hit command docker ps to list them and check their status.

CONTAINER ID   IMAGE                                        COMMAND                  CREATED         STATUS                   PORTS                              NAMES
efe502f08d3c   node:24.13.0-slim                            "docker-entrypoint.s…"   6 minutes ago   Up 6 minutes             0.0.0.0:7777->7777/tcp             farm-proxy-gui
a43273d5d2a8   grafana/grafana:9.5.1                        "/run.sh"                6 minutes ago   Up 6 minutes (healthy)   0.0.0.0:3000->3000/tcp             grafana
091ea1d94da7   braiinssystems/farm-proxy:26.02              "/usr/local/bin/farm…"   6 minutes ago   Up 6 minutes (healthy)   0.0.0.0:3333-3339->3333-3339/tcp   farm-proxy
c3130fb17a86   prom/prometheus:latest                       "/bin/prometheus --c…"   6 minutes ago   Up 6 minutes (healthy)   0.0.0.0:9090->9090/tcp             prometheus

Similarly you can check the created volumes, containers and images docker volume ls;docker image ls;docker container ls. Check the Troubleshooting section for any troubles you might face after startup.

Restart

In case Braiins Farm Proxy needs a restart, run the command docker compose restart farm-proxy. The command will restart only the farm-proxy container. Restart of farm-proxy is needed in case it gets stuck. As opposed to previous version, it's not needed to restart Farm Proxy anymore to apply new configuration (check Configuration section to understand how to reconfigure Farm Proxy). If you wish to restart another Docker container it can be done similarly by replacing farm-proxy with the name of the container that needs a restart.

Stop

Sometimes the mining operator may want to stop Braiins Farm Proxy. It can be done in Linux terminal with the command docker compose stop farm-proxy. It is needed in case of any changes in the file docker-compose.yml. To run proxy again, run the command docker compose up -d farm-proxy. If you wish to stop another Docker container it can be done similarly.

Upgrade from version 23.05 and older

Below Upgrade section is valid in general. However, when coming from older versions of Farm Proxy to version 24.06 (or following versions) there are bigger changes. Docker compose file has been reworked for integration of configuration GUI. Make sure to use the docker compose file from new version instead of trying to merge differences to your current docker compose file. Also make sure to backup any configuration .toml file which you might need later. Example configuration files distributed with previous versions have been deleted from the repository and will be deleted from your file system too during the upgrade. Check the Configuration section for details how to properly configure Farm Proxy after this upgrade.

Upgrade

Braiins recommends miners to follow the Braiins Farm Proxy Github repository to be notified if a new version is available. If you made any changes in the configuration files you might want to save them to a backup folder before the upgrade. To upgrade to a newer version just run the command git pull origin master in the Linux terminal.

#Uninstall for Linux PC and Raspberry Pi

To completely remove farm-proxy and out-of-the-box monitoring from your system you need to perform the following steps:

Note: docker prune will delete all unused containers/images/volumes from your system, even the ones not related to farm-proxy.

# Stop farm-proxy & out-of-the-box monitoring, remove associated volumes
docker compose down -v
# Remove containers & images
docker container prune; docker image prune -a
# Remove stored monitoring data
docker volume prune
# Remove the folder
rm -rf farm-proxy/

#HW requirements

Recommended hardware requirements:

• RaspberryPi 3 or 4 with at least 4GB RAM: ~ 500 miners per proxy instance.
• Linux PC, with minimum 4 core processor and 8GB RAM: ~ 2,500 miners per proxy instance.
• Linux PC, with minimum 8 core processor and 16GB RAM: ~ 10,000 miners per proxy instance.
• Enterprise server: ~ 10,000+ miners