Giter Site home page Giter Site logo

docker-stratum-relay's Introduction

Luxor Relay

Contributors Forks Stargazers Issues

luxor-relay is a stratum-compatible proxy that assists with managing large scale ASIC deployments.

  • Single connection for up to 65000 miners. This reduces the load on datacenter networking gear.
  • Manages connection redundancy. If the pool disconnects, miners don't drop.
  • Lower bandwidth - Relay compresses the miner shares by up to 90%.
  • Improved efficiency and reduces stales.
  • Incredible view of stratum statistics. Every share gets accounted for in our custom built dashboards.
  • Simple setup. Just install docker and run docker compose up.
  • Multi-tenancy - supports multiple usernames with a single Relay deployment.
  • Low memory footprint - works on most devices.

Getting Started

To get started with Luxor Relay, there are a few requirements for your computer. We highly recommend setting up a machine on-premise in the datacenter.

First, we must install Docker. You can do that here.

The latest versions of Docker on certain operating systems includes docker-compose by default. However, some OS have docker-compose as a seperate package. You can view your operating system settings through the setup guide here.

Once Docker is installed, clone this repo into your local system:

git clone https://github.com/LuxorLabs/docker-stratum-relay.git

Then cd into the root directory:

cd docker-stratum-relay

Finally, you can bootup the entire Luxor Relay stack with docker-compose.

If you have a Docker instance with compose built in you can run:

docker compose up

If you have a Docker instance with a seperate docker-compose installation, you can run:

docker-compose up

Notice the main difference is the - which references the specific binary we're using.

To stop Luxor Relay at any time, just run docker compose down or docker-compose down, depending on your system setup.

You can also run the Docker containers in the background with:

docker compose up -d

Updating Miner Config

To switch the miners over to use the Relay, just update the Stratum URL:

<relay_ip_adr>:5010

System Requirements

The full Relay installation will require:

  • 500Mb of disk space for the docker images
  • 250Mb of memory for the Grafana + Prometheus metrics

Accessing the Dashboard

Luxor Relay comes with a full metrics suite for analyzing share data and hashrate efficiency. We use Grafana and VictoriaMetrics to achieve this. You can access the dashboard once the docker-compose stack is up by going to http://localhost:3010/d/relay/luxor-relay-metrics in your browser.

Happy hashing!

docker-stratum-relay's People

Contributors

eddiewang avatar hashbender avatar islopma avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.