Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a Dockerfile for building container images and some documentation #223

Closed
wants to merge 2 commits into from

Conversation

au-ee
Copy link

@au-ee au-ee commented Jun 26, 2021

Description

A first approach in creating a docker image to get rid of python dependencies.

Fixes #79 (partly)
My focus was on having a small Docker image which gets me rid of the python dependencies on my Raspberry Pi.
Following my approach, run.py has to be mapped into the container. However, I like the approach described in #79. Probably something to consider in the future. See this one as a first step.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality not to work as expected)

How Has This Been Tested?

I built the docker image on a Raspberry Pi (docker-ce) and on the latest MacOS (Docker Desktop) and was able to run the app within the container.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md) ... created DOCKE.md
  • My changes generate no new warnings
  • [n/a] Any dependent changes have been updated in requirements.txt

DOCKER.md Outdated
## Running the docker image

```bash
docker run -d -p 5000:5000 -v /path/to/your/run.py:/Twitch-Channel-Points-Miner-v2/run.py --name miner --restart unless-stopped tcpm
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should mention that using this command, analytics will be lost when the docker container will be restarted.

Also the cookies folder should probably be mounted. Loggin in every time would be annoying, and if you have a captcha or 2FA I'm not sure that the script is able to fully login from within the container.

@Tkd-Alex Tkd-Alex mentioned this pull request Aug 5, 2021
@Tkd-Alex
Copy link
Owner

https://github.com/RakSrinaNa/Twitch-Miner

We have here another Dockerfile 🥳

@Tkd-Alex Tkd-Alex added the enhancement New feature or request label Aug 16, 2021
@Rakambda
Copy link
Contributor

Rakambda commented Nov 4, 2021

I plan on stepping back a bit from this project. I made my own version of it and therefore won't really have any interest in participating quite a lot on the different issues/PR.

As it stands, the Docker part is not merged and quite some people seem to rely on the Docker image used by the repository above.
I plan on archiving it and removing the image from docker as it will lead to confusion over time between this project and my rewrite. Probably will happen at the start of 2022.

If there's anything that people wanna grab from that repo (like the Github actions / docker-compose example / the Docker file adapted to be built on the CI and for various architectures) to be integrated here then feel free to do so. I guess it would be better to have a CI in this repo that pushes to docker when a push is made on the main branch (rather than a corn like I do).
However, if @Tkd-Alex you wanna keep it separate to have the CI elsewhere I'm willing to transfer that repository.

In any case, the docker image itself will be removed at some point and considering it has 500k+ downloads it may be something worth to be looked at before the deletion's done.

@Tkd-Alex
Copy link
Owner

I plan on stepping back a bit from this project. I made my own version of it and therefore won't really have any interest in participating quite a lot on the different issues/PR.

As it stands, the Docker part is not merged and quite some people seem to rely on the Docker image used by the repository above. I plan on archiving it and removing the image from docker as it will lead to confusion over time between this project and my rewrite. Probably will happen at the start of 2022.

If there's anything that people wanna grab from that repo (like the Github actions / docker-compose example / the Docker file adapted to be built on the CI and for various architectures) to be integrated here then feel free to do so. I guess it would be better to have a CI in this repo that pushes to docker when a push is made on the main branch (rather than a corn like I do). However, if @Tkd-Alex you wanna keep it separate to have the CI elsewhere I'm willing to transfer that repository.

In any case, the docker image itself will be removed at some point and considering it has 500k+ downloads it may be something worth to be looked at before the deletion's done.

Thank you for the time spent on this project! ❤️
Yup, we should talk about the Docker image. I agree to build a CI with Docker and maybe also with pip, but for the moment I don't know how to achieve this. I plan to do in future

@Tkd-Alex Tkd-Alex closed this Nov 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docker Support
3 participants