Add example for INVENTREE_CUSTOMIZE environment variable #8314
Conversation
✅ Deploy Preview for inventree-web-pui-preview canceled.
|
docs/docs/start/config.md
Outdated
| @@ -369,6 +369,15 @@ The logo and custom messages can be changed/set: | |||
| | INVENTREE_CUSTOMIZE | customize.navbar_message | Custom message for navbar | *Not specified* | | |||
| | INVENTREE_CUSTOMIZE | customize.hide_pui_banner | Disable PUI banner | False | | |||
|
|
|||
| The INVENTREE_CUSTOMIZE environment variable must contain a json object with the keys from the table above and | |||
| the wanted values. Setting the variable is a bit tricky in bash because of json syntax. Example: | |||
There was a problem hiding this comment.
Why would you set them in bash? That is the dumbest of all config ways to do this
There was a problem hiding this comment.
@matmair what would you suggest here for a better example?
There was a problem hiding this comment.
I would suggest to not recommend bash for configuring inventree outright. Once the server is restarted the settings are gone if not set correctly (which we do not explain or recommend anywhere). We provide and document either the yaml or environment variables everywhere else, this inclusion will just lead to confusion.
There was a problem hiding this comment.
Good morning,
I do not care is you use bash, csh, tcsh, ksh,sh or whatever kind of system. I just wanted to add something to a position where we stumbled. Because from the table alone, it is not obvious what the content of the variable should look like. Three times the same variable name in the table looks strange without further description.
Michael
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #8314 +/- ##
==========================================
- Coverage 84.35% 81.70% -2.66%
==========================================
Files 1165 1165
Lines 52845 56789 +3944
Branches 1931 1931
==========================================
+ Hits 44577 46399 +1822
- Misses 7774 9896 +2122
Partials 494 494
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
I removed the bash example and just mentioned the content of the variable. OK now? |
|
Yes this reduced sample is fine, thanks |
Our admin struggled a bit with this :-)