Updated options file with singlefile options and page restructure #705
Conversation
| @@ -25,21 +25,78 @@ All options need to be defined as environment variables in the environment that | |||
|
|
|||
| ## List of options | |||
There was a problem hiding this comment.
Let's remove this one, seems superfluous with the new categories.
|
|
||
| A json string with additional options for the database. Passed directly to OPTIONS. | ||
|
|
||
| ### `LD_FAVICON_PROVIDER` |
There was a problem hiding this comment.
Let's move this out of database options. I'd suggest to have a "Other options" or some other catch all category.
| The password for the initial superuser. | ||
| When left undefined, the superuser will be created without a usable password, which means the user can not authenticate using credentials / through the login form, and can only be authenticated using proxy authentication (see [`LD_ENABLE_AUTH_PROXY`](#ld_enable_auth_proxy)). | ||
|
|
||
| ## Background Tasks |
There was a problem hiding this comment.
This also contains a number of things not related to background tasks. Maybe repurpose this as the "Other options" category. Would also make sense to move this to the bottom of the doc then.
|
|
||
| ### `LD_DB_USER` | ||
| ### `LD_ENABLE_SNAPSHOTS` |
There was a problem hiding this comment.
This should not be exposed to users, it's only an internal marker for the app to know whether the dependencies for creating snapshots are installed and can be used. Changing this in the base image would result in broken features. Let's remove this.
|
|
||
| Alternative favicon providers: | ||
| - DuckDuckGo: `https://icons.duckduckgo.com/ip3/{domain}.ico` | ||
| ## Superuser Options |
There was a problem hiding this comment.
These might be the most used options, which is why I had it at the top. Let's move it back there.
|
|
||
| ### `LD_DB_PORT` | ||
| ### `LD_SINGLEFILE_PATH` |
There was a problem hiding this comment.
This probably shouldn't be changed either. If there's no use case for changing this it seems better to remove it to reduce confusion for readers what they should do with it.
I noticed the Options doc did not contain a number of single-file options, and some option defaults were incorrect.
I have updated them as best as I can, and also added a bit more structure into the document, given the number of options.