doc: missing entries in config.md
Massimo Melina committed
Jun 25, 2024 at 09:21 UTC
80733ee2f349b3e5218a33ed819e18613d5e3243
2 files changed
+14
-4
config.md
+11
-1
@@ -43,7 +43,10 @@ Configuration can be done in several ways
43
- `log` path of the log file. Default is `access.log`.
44
- `log_rotation` frequency of log rotation. Accepted values are `daily`, `weekly`, `monthly`, or empty string to disable. Default is `weekly`.
45
- `log_api` should api calls be logged? Default is `true`.
46
-- `log_gui` should GUI files be logged? Default is `false`.
46
+- `log_gui` should GUI files be logged? Default is `false`.
47
+- `log_spam` log *failed* requests that are considered spam. Default is false.
48
+- `log_ua` include user-agent in the logs. Default is false.
49
+- `track_ips` keep track of all IP addresses seen. Default is true.
50
- `error_log` path of the log file for errors. Default is `error.log`.
51
- `errors_in_main_log` if you want to use a single file for both kind of entries. Default is false.
52
- `dont_log_net` don't include in log entries if IP matches this network mask. Default is `127.0.0.1|::1`.
@@ -92,6 +95,12 @@ Configuration can be done in several ways
95
- `descript_ion_encoding` text encoding to be used for file *DESCRIPT.ION*. [List of supported values](https://github.com/ashtuchkin/iconv-lite/wiki/Supported-Encodings). Default is `utf8`.
96
- `server_code` javascript code that works similarly to [a plugin](dev-plugins.md).
97
- `tiles_size` starting value for frontend's tiles size. Default is 0.
98
+- `auto_play_seconds` starting value for frontend's auto_play_seconds (used in Show). Default is 5.
99
+- `theme` starting value for theme. Default is "auto".
100
+- `sort_by` starting value for sort-by. Values can be: name, extension, size, time. Default is "name".
101
+- `sort_numerics` starting value for sort-numeric-names. Default is false.
102
+- `folders_first` starting value for sort-folders-first. Default is true.
103
+- `invert_order` starting value for invert-order. Default is false.
104
- `update_to_beta` includes beta versions searching for updates. Default is false.
105
- `roots` maps hosts (or mask of hosts) to a root different from the home folder. Default is none. E.g.
106
```
@@ -109,6 +118,7 @@ Configuration can be done in several ways
118
- `dynamic_dns_url` URL to be requested to keep a domain updated with your latest IP address.
119
Optionally, you can append “>” followed by a regular expression to determine a successful answer, otherwise status code will be used.
120
Multiple URLs are supported and you can specify one for each line.
121
+- `auto_basic` automatically detect (based on user-agent) when the basic web inteface should be served, to support legacy browsers. Default true.
122
- `create-admin` special entry to quickly create an admin account. The value will be set as password. As soon as the account is created, this entry is removed.
123
124
#### Virtual File System (VFS)
dev-plugins.md
+3
-3
@@ -97,9 +97,9 @@ used must be strictly JSON (thus, no single quotes, only double quotes for strin
97
You can read more in [the ctx object](#the-ctx-object) section.
98
99
- `unload: function` called when unloading a plugin. This is a good place for example to clearInterval().
100
-- `onDirEntry: ({ entry: DirEntry, listUri: string }) => Promisable<void | false>` by providing this callback you can manipulate
101
- the record that is sent to the frontend (`entry`), or you can return false to exclude this entry from the results.
102
- Refer to source `frontend/src/state.ts`.
100
+- `onDirEntry: ({ entry: DirEntry, listUri: string, ctx, node: VfsNode }) => Promisable<void | false>`
101
+ by providing this callback you can manipulate the record that is sent to the frontend (`entry`),
102
+ or you can return false to exclude this entry from the results. Refer to source `frontend/src/state.ts`.
103
- `config: { [key]: FieldDescriptor }` declare a set of admin-configurable values owned by the plugin
104
that will be displayed inside Admin-panel for change. Each property is identified by its key,
105
and the descriptor is another object with options about the field.