use dotenv to handle environment variables

camicroscope / Caracal

Conslidated Backend, Auth, and Security Services for caMicroscope

GNU General Public License v3.0

15 stars 95 forks source link

use dotenv to handle environment variables #74

Closed YashKumarVerma closed 3 years ago

YashKumarVerma commented 3 years ago

Is your feature request related to a problem? Please describe. by using a .env file, we can handle & document environment variables in a better manner as

no need to pass as cli option
can be used while running scripts
can be grouped and used in batches

Describe the solution you'd like

using a library like dotenv which uses a .env file.
(also?) a .env.example file with all possible configuration options that are possible via environment variables.

Describe alternatives you've considered

yaml based configs can also be used.

Additional context Add any other context or screenshots about the feature request here.

willing to work on it

birm commented 3 years ago

I would recommend considering caracal in the context which camicroscope usually deploys it: https://github.com/camicroscope/Distro

That said, as long as there's no confusion, I'm happy to let caracal support .env files too.

YashKumarVerma commented 3 years ago

I would recommend considering caracal in the context which camicroscope usually deploys it: camicroscope/Distro

That said, as long as there's no confusion, I'm happy to let caracal support .env files too.

please correct me if I'm wrong, I'm learning a lot of new things here. So this repository (Caracal) is used by Distro to build a new image.

and implementing dotenv in this repo is fine right?

birm commented 3 years ago

Yes, I should have been more clear. I was just saying that I find it easier to use a compose script to pass env vars where possible. But, this isn't necessarily bound to caMicroscope, so I do think this is a good proposal.

YashKumarVerma commented 3 years ago

thanks for the assistance!