search

codeproject / CodeProject.AI-Server

CodeProject.AI Server is a self contained service that software developers can include in, and distribute with, their applications in order to augment their apps with the power of AI.
Other
605 stars 141 forks source link

[DOCS]: Environment Variables #1

Closed stavros-k closed 1 year ago

stavros-k commented 2 years ago

Hey, just added this project in TrueNAS SCALE community catalog as a Helm Chart. It would be nice to have a small list of supported environment variables, so I can expose those on the installation UI in TrueNAS!

Thanks!

ChrisMaunder commented 2 years ago

We're more than happy to work with you on this. Just let us know the specifics of what you're after and we can ensure our docs are up to date. Note that each module included in our AI server has it's own inputs, outputs and environment variables. Our server has it's variables, and they are fixed, but the list of modules will be a changeable beast.

Just let us know what you need and we'll get on it.

stavros-k commented 2 years ago

I don't have any specific request, but if there are any env's that people would like to change often, it would be nice to have them exposed in the Truenas GUI.

If there aren't any it's also okay! I have already added the app and it's working.

*GUI also gives the option to users to dynamically add env's that are not predefined, just takes couple more clicks.

eg: This is a predefined variable, that you only need to change its value image

This is the dymanic part where users can add any env they want image

Besides all that, it would be nice to have the various env's of each module (even a link to the upstream docs will do). With that users will see what are the available options and will know what each options does. Of course documenting things is not a one night task to deal.

ChrisMaunder commented 1 year ago

All settings are now documented at https://www.codeproject.com/AI/docs/api/module_settings.html