plane icon indicating copy to clipboard operation
plane copied to clipboard

[feature]: Document existing environment variables

Open simonmicro opened this issue 2 years ago • 0 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Summary

While a minimalistic instruction set for self-hosting exist, it does not include what can be configured (where).

Yes, there exists the .env.example, but who knows what which variable expects... I do NOT expect a whole guide how to e.g. setup a Slack integration, but it would be useful to know what to put where to get it working.

Why should this be worked on?

To allow simpler self-hosting and evaluation of this software before deployment into production.

With the current setup I'm not sure, if I really want to self-host this software, nor if it is ready for production use. I've dived into the code to figure out what was going on, but (partially due to my limited knowledge of React) as an ops-guy (and a dev) the code is not documented in any way to allow inference of knowledge needed for proper configuration. In combination with the missing documentation, this is a huge problem!

simonmicro avatar May 06 '23 18:05 simonmicro