Is your feature request related to a problem? Please describe.
Yes and no. I was trying to configure my Docker's "openwebui" volume by editing /var/lib/docker/volumes/open-webui/_data/config.json and it's not clear what the available parameters are, even searching the web, or digging around in the documentation.
Describe the solution you'd like
A page that explains the available parameters of config.json.
Describe alternatives you've considered
Searched the documentation and the web. Nothing. Not that I could find at least.
Additional context
-
Originally created by @Fusseldieb on GitHub (Apr 5, 2024).
Original GitHub issue: https://github.com/open-webui/open-webui/issues/1428
**Is your feature request related to a problem? Please describe.**
Yes and no. I was trying to configure my Docker's "openwebui" volume by editing `/var/lib/docker/volumes/open-webui/_data/config.json` and it's not clear what the available parameters are, even searching the web, or digging around in the documentation.
**Describe the solution you'd like**
A page that explains the available parameters of `config.json`.
**Describe alternatives you've considered**
Searched the documentation and the web. Nothing. Not that I could find at least.
**Additional context**
\-
This is an internal configuration file created by WebUI itself and not currently used.
<!-- gh-comment-id:2039580720 -->
@justinh-rahb commented on GitHub (Apr 5, 2024):
This is an internal configuration file created by WebUI itself and not currently used.
I'm aware of this, but it's, as far as I know, the only way that some default settings can be changed.
Even though not everyone should change things in there, having it documented would give people insight of what it does, and what are all the possible parameters.
<!-- gh-comment-id:2039628425 -->
@Fusseldieb commented on GitHub (Apr 5, 2024):
Thank you for your answer.
I'm aware of this, but it's, as far as I know, the only way that _some_ default settings can be changed.
Even though not everyone should change things in there, having it documented would give people insight of what it does, and what are all the possible parameters.
Even though not everyone should change things in there, having it documented would give people insight of what it does, and what are all the possible parameters.
That documentation can be found here for anyone that needs to know. I don't see any reason we need to duplicate it in our own.
<!-- gh-comment-id:2039637596 -->
@justinh-rahb commented on GitHub (Apr 5, 2024):
> Even though not everyone should change things in there, having it documented would give people insight of what it does, and what are all the possible parameters.
That documentation can be found [here](https://docs.docker.com/storage/volumes/) for anyone that needs to know. I don't see any reason we need to duplicate it in our own.
It's not about duplication. The Docker page mentions the creation of volumes, but not specific parameters (aka key:value pairs) of a config.json, for obvious reasons. The configuration file is specific to openwebui, and currently not documented anywhere, unless you dig into the Python files.
I'm not talking about "version" key. I'm talking about the whole "ui" portion, such as:
default_locale
prompt_suggestions
(?)
They are indeed self-explanatory, but there's no documentation anywhere if more things are supported, or if that is all there is.
<!-- gh-comment-id:2039741643 -->
@Fusseldieb commented on GitHub (Apr 5, 2024):
It's not about duplication. The Docker page mentions the creation of volumes, but not specific parameters (aka key:value pairs) of a config.json, for obvious reasons. The configuration file is specific to openwebui, and currently not documented anywhere, unless you dig into the Python files.
I'm not talking about "version" key. I'm talking about the whole "ui" portion, such as:
- default_locale
- prompt_suggestions
- (?)
They are indeed self-explanatory, but there's no documentation anywhere if more things are supported, or if that is all there is.
My confusion, your path /var/lib/docker/volumes/open-webui/_data/config.json threw me off. That's the direct (host filesystem) location of a docker volume and its contents. This is not supposed to be touched outside of the container that owns it or it could lead to unspecified errors.
<!-- gh-comment-id:2039747986 -->
@justinh-rahb commented on GitHub (Apr 5, 2024):
My confusion, your path `/var/lib/docker/volumes/open-webui/_data/config.json` threw me off. That's the direct (host filesystem) location of a docker volume and its contents. This is not supposed to be touched outside of the container that owns it or it could lead to unspecified errors.
My confusion, your path /var/lib/docker/volumes/open-webui/_data/config.json threw me off. That's the direct (host filesystem) location of a docker volume and its contents. This is not supposed to be touched outside of the container that owns it or it could lead to unspecified errors.
Oh well. Is there a better way to throw in this file for it to read, instead of directly writing to it?
<!-- gh-comment-id:2039761324 -->
@Fusseldieb commented on GitHub (Apr 5, 2024):
> My confusion, your path `/var/lib/docker/volumes/open-webui/_data/config.json` threw me off. That's the direct (host filesystem) location of a docker volume and its contents. This is not supposed to be touched outside of the container that owns it or it could lead to unspecified errors.
Oh well. Is there a better way to throw in this file for it to read, instead of directly writing to it?
It's currently only used for setting the default prompt suggestions and language. There will be future updates to save more settings in that file, at which time they will all be documented as well.
<!-- gh-comment-id:2039778152 -->
@justinh-rahb commented on GitHub (Apr 5, 2024):
It's currently only used for setting the default prompt suggestions and language. There will be future updates to save more settings in that file, at which time they will all be documented as well.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Originally created by @Fusseldieb on GitHub (Apr 5, 2024).
Original GitHub issue: https://github.com/open-webui/open-webui/issues/1428
Is your feature request related to a problem? Please describe.
Yes and no. I was trying to configure my Docker's "openwebui" volume by editing
/var/lib/docker/volumes/open-webui/_data/config.jsonand it's not clear what the available parameters are, even searching the web, or digging around in the documentation.Describe the solution you'd like
A page that explains the available parameters of
config.json.Describe alternatives you've considered
Searched the documentation and the web. Nothing. Not that I could find at least.
Additional context
-
@justinh-rahb commented on GitHub (Apr 5, 2024):
This is an internal configuration file created by WebUI itself and not currently used.
@Fusseldieb commented on GitHub (Apr 5, 2024):
Thank you for your answer.
I'm aware of this, but it's, as far as I know, the only way that some default settings can be changed.
Even though not everyone should change things in there, having it documented would give people insight of what it does, and what are all the possible parameters.
@justinh-rahb commented on GitHub (Apr 5, 2024):
That documentation can be found here for anyone that needs to know. I don't see any reason we need to duplicate it in our own.
@Fusseldieb commented on GitHub (Apr 5, 2024):
It's not about duplication. The Docker page mentions the creation of volumes, but not specific parameters (aka key:value pairs) of a config.json, for obvious reasons. The configuration file is specific to openwebui, and currently not documented anywhere, unless you dig into the Python files.
I'm not talking about "version" key. I'm talking about the whole "ui" portion, such as:
They are indeed self-explanatory, but there's no documentation anywhere if more things are supported, or if that is all there is.
@justinh-rahb commented on GitHub (Apr 5, 2024):
My confusion, your path
/var/lib/docker/volumes/open-webui/_data/config.jsonthrew me off. That's the direct (host filesystem) location of a docker volume and its contents. This is not supposed to be touched outside of the container that owns it or it could lead to unspecified errors.@Fusseldieb commented on GitHub (Apr 5, 2024):
Oh well. Is there a better way to throw in this file for it to read, instead of directly writing to it?
@justinh-rahb commented on GitHub (Apr 5, 2024):
It's currently only used for setting the default prompt suggestions and language. There will be future updates to save more settings in that file, at which time they will all be documented as well.
@Fusseldieb commented on GitHub (Apr 5, 2024):
Nice to hear!
Thanks for your time!
@tjbck commented on GitHub (Apr 5, 2024):
Let's continue our discussion here: open-webui/docs#44