gomods / athens

A Go module datastore and proxy
https://docs.gomods.io
MIT License
4.38k stars 490 forks source link

Document config.toml basics #1502

Open arschles opened 4 years ago

arschles commented 4 years ago

Is your feature request related to a problem? Please describe.

Our configuration documentation has a lot of specific information, but very little general overview on how to configure Athens.

Describe the solution you'd like

We should have documentation explaining the config.toml file, environment variables, and even the configuration that you can do via the helm chart.

Describe alternatives you've considered

N/A

Additional context

This should be probably be solved at the same time as https://github.com/gomods/athens-charts/issues/29

dhiemaz commented 4 years ago

@arschles, I want to help for this.. :)

arschles commented 4 years ago

@dhiemaz please do! I just created a new issue gomods/athens#1550 with an idea of how this might be done more easily. What do you think about that?

dhiemaz commented 4 years ago

Hi @arschles let me check that first ya..

arschles commented 4 years ago

@dhiemaz sounds good. Let me know what you think 😄 👍