Configuring with ENVs

[warren-ru]

As discussed I've made a few updates for providing some settings through environments.
All settings from auth.yml can be now provided with envs.

[warren-ru]

Config files shouldn't be part of the Docker image. They should be provided externally instead.
So example config files are copied while container building.

[Linus045]

Please also run 'black' to fix the CI checks (see README.md).

see CI check log:

would reformat src/gateio_new_coins_announcements_bot/auth/gateio_auth.py
would reformat src/gateio_new_coins_announcements_bot/send_telegram.py

[Linus045]

I'm not too familiar with Docker but can you easily edit files afterwards once you created the Docker?

The problem I'm seeing here, if you can't edit easily inside the docker.,is that you would need to edit the .example files beforehand and then create the Docker Container.
This would then cause problems when you try to update the git repo (git pull) by causing merge conflicts, since the .example files are tracked by git.

I would prefer to stick with the old untracked files: config.yml, auth.yml and old_coins.json, that way you're not forced to edit the tracked .example files.

[warren-ru]

The other problem now is that image won't be built cause the git repo doesn't contain the necessary config files.

Config files should be provided from the outside, they can be mounted from any path of the host. Or someone can use default settings and provide secrets through the ENV. Provided from the outside config files doesn't affect git repo in any way. You can take a look at the Docker storage concept here

Moreover, we can publish the app image in the GitHub repo image registry. So it will be no necessity to build an image for use, you could just pull it from the official repo registry.

[warren-ru]

If you provide you config before building, you have to rebuild you image after every config change.
Or you can edit files in the container, it's not a big deal. But when you kill the container and start it again all your edits would be lost

[Linus045]

I read through the link you proved a bit and like the idea of using volumes/mounting to separate the config from the container.
We should also consider #130 to make it easier.
I would like to rework the whole Docker structure and make it properly useable/configurable.

For that I need to take a closer look at Docker first but the problem is that I'm currently busy with life for the next two weeks or so.

Regarding this PR. I would like to keep the current Dockerfile the same, as to not suddenly change the behavior (what config.yml/auth.yml file is needed) and in a new PR we can rework the whole Docker integration to utilize mounting or volumes (after I familiarized myself more).

Therefore this PR will just merge the environment variable changes.

• Revert path changes in Dockerfile

Whats your opinion on this?

[warren-ru]

If the config files were moved to a single directory it would be not so much to reorder in the Dockerfile. But moving them is up to the app.
You are free to revert Dockerfile. It's just the setup I personally use at the moment, as long as the config files are not reordered.

[Linus045]

I don't fully understand what you mean by "moving them up to the app"

As I understand it we would use the (then existing) config directory (<root>/config) to have the config/auth.yml file in one directory and then mount that directory into the docker container.
That way we can change the config file and just restart the container/bot and it will apply the changes without use needing to rebuild the whole container.

In that case we would still call the files option.yml and auth.yml and keep the .example files as they are, so source control wouldn't mark them as changed.
The options.yml and auth,yml are in .gitignore so you can configure them freely.

I will take a closer look at this once i have more time on my hand.

[warren-ru]

I meant we need change the app code to move config files.

[Linus045]

Maybe also mention that Env parameters are prioritized over the settings in the auth.yml file.
So there is no confusion if you have both set.

[warren-ru]

Done

[warren-ru]

Please also run 'black' to fix the CI checks (see README.md).

see CI check log:

would reformat src/gateio_new_coins_announcements_bot/auth/gateio_auth.py
would reformat src/gateio_new_coins_announcements_bot/send_telegram.py

Done

[warren-ru]

We can add to the README an example of how to run the image with the config files mounted

[warren-ru]

We can add to the README an example of how to run the image with the config files mounted

It could be something like:

docker build -t gateio_cryptobot . && \
docker run --name crypto-bot -d --restart always \
     -v ~/gateio-bot/config.yml:/app/config.yml \
     -v ~/gateio-bot/old_coins.json:/app/old_coins.json \
     -v ~/gateio-bot/auth.yml:/app/auth/auth.yml \
     gateio_cryptobot

assuming config files are stored at ~/gateio-bot/