Read this in other languages:
luxor-tcpcipher
is a stratum-compatible proxy for establishing encrypted
connections between clients and the mining pool.
- Secure encrpyted connection circumvents limitations for clients accessing the mining pool behind a firewall.
- Simple setup. Just install docker, set
redirectTo
config option and rundocker compose up
. - Low memory footprint - works on most devices.
To get started with Luxor Tcpcipher, 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-tcpcipher.git
Then cd
into the root directory:
cd docker-tcpcipher
Finally, you can bootup the entire Luxor Tcpcipher 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 Tcipcipher 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
Tcpcipher already comes configured to encrypt received data before sending it to the decrypting instance.
To switch the miners over to use the tcpcipher, just update the Stratum URL:
<tcpcipher_ip_adr>:8383
The full Relay installation will require:
- 100Mb of disk space for the docker images
- 250Mb of memory for relay instance
Happy hashing!