Giter Club home page Giter Club logo

docker-tdm's Introduction

docker-tdm

A docker image that runs TwitchDropsMiner in a container with a VNC server. This allows the application to be deployed in a headless environment while still being configured through the GUI on a remote device by using a VNC viewer.

Usage

Clone: git clone https://github.com/SimonAkers/docker-tdm.git

Build: docker compose build

Start: docker compose up -d

Stop: docker compose down

Environment Variables

These variables are used in the container's build and run processes, located in the .env file.

  • VNCPASS (run) - The password for the VNC server.
    • Default: letmein
  • TDM_REPO (build, run) - The miner repository to use.
    • Default: https://github.com/DevilXD/TwitchDropsMiner
    • This is helpful if a forked version of the miner has implemented a critical patch before the main version.
    • It is recommended to use the main repository if possible, as forks are not guaranteed to work without modification to the image settings.
    • You must delete the existing repository and/or image for a new one to be cloned. It is recommend to build and deploy from scratch if changing repo.

Main Components

Ubuntu 22.04 python3 pip3 x11vnc xvfb fluxbox xdotool wmctrl git TwitchDropsMiner

Notes

  • The VNC server should be compatible with any standard VNC viewer. I used TightVNC while making this.

  • This container is NOT intended to have its ports exposed to the Internet. It was not designed using rigorous security practices and I am using a plain-text password for the VNC server. USE AT YOUR OWN RISK!

  • ALL ISSUES SHOULD BE REPORTED HERE FIRST. Docker usage is not supported by the TDM maintainers, so any issues when using this container should go through this repository first. If it turns out to be an issue with TDM itself, then we can proceed to move the issue to that repository.

Known Issues

  • After connecting to the VNC server, clicking the "Minimize to Tray" button causes the window to entirely disappear, even if you were to use a window manager and system tray. Restarting the container should restore the window. I have not yet found a way around this.

docker-tdm's People

Contributors

simonakers avatar

Stargazers

 avatar

Watchers

 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.