bitmagnet icon indicating copy to clipboard operation
bitmagnet copied to clipboard

Envoiroment variables maps for settings and better config documentation

Open silajim opened this issue 1 month ago • 4 comments

  • [x ] I have checked the existing issues to avoid duplicates
  • [ x] I have redacted any info hashes and content metadata from any logs or screenshots attached to this issue

Is your feature request related to a problem? Please describe

I was (and still am) trying to disable the tmdb with this config file, but the yaml documentation is technically not existent, like and the environment variables are not listed anywhere

Describe the solution you'd like

I'd like to see all the yaml options, with a functioning yaml example with ALL the options and ALL the environment variables listed and to what they map to

Additional context

Also, I'd like more debug in case the yaml fails to parse, currently I am having issues with the yaml file and it always says it cannot be opened but the container can open it from the console. I've attached the yaml that gives me issues.

config.yml

silajim avatar Nov 06 '25 21:11 silajim

This is all already available by running bitmagnet config show (documented here https://bitmagnet.io/setup/configuration.html ). Looking at your config file you have a bunch of invalid values under classifier that should be in classifier.yml, not the main config file (also documented).

If you remove the invalid classifier section and make sure the file is in the correct location it should all work and you can verify this with the config show command.

mgdigital avatar Nov 06 '25 23:11 mgdigital

running bitmagnet config show is not appropiate, all config should be documented and all environment variables, things that can be copy pasted, even when the program cannot run.

Looking at your config file you have a bunch of invalid values under classifier that should be in classifier.yml, not the main config file (also documented).

If you remove the invalid classifier section and make sure the file is in the correct location it should all work and you can verify this with the config show command.

They are part of the config.yaml.example! I did not add them

silajim avatar Nov 06 '25 23:11 silajim

They are part of the config.yaml.example! I did not add them

Which example? It's not from any official example, it seems to be a mish mash of things copy pasted into the wrong place.

all config should be documented and all environment variables

They are all listed when you run config show, and all relevant ones are documented on the website. If it isn't documented on the website you 99% don't need to touch it, however in the next version there will be a better auto generated and comprehensive list of config params.

mgdigital avatar Nov 06 '25 23:11 mgdigital

Which example? It's not from any official example, it seems to be a mish mash of things copy pasted into the wrong place.

I need to bark at the unraid container manager then, sorry

They are all listed when you run config show, and all relevant ones are documented on the website. If it isn't documented on the website you 99% don't need to touch it, however in the next version there will be a better auto generated and comprehensive list of config params.

Okay, great!

silajim avatar Nov 06 '25 23:11 silajim