Skip to content

Commit 55d8a88

Browse files
authored
Updating splunk.conf in docker-splunk docs (#357)
* Updating splunk.conf in docker-splunk docs
1 parent 364107d commit 55d8a88

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/ADVANCED.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -230,15 +230,18 @@ User-specified config files are set in `default.yml` by creating a `conf` key un
230230
---
231231
splunk:
232232
conf:
233-
user-prefs:
234-
directory: /opt/splunkforwarder/etc/users/admin/user-prefs/local
235-
content:
236-
general:
237-
default_namespace: appboilerplate
238-
search_syntax_highlighting: dark
233+
- key: user-prefs
234+
value:
235+
directory: /opt/splunkforwarder/etc/users/admin/user-prefs/local
236+
content:
237+
general:
238+
default_namespace: appboilerplate
239+
search_syntax_highlighting: dark
239240
...
240241
```
241242

243+
**NOTE:** Previously, the `splunk.conf` entry supported a dictionary mapping. Both types will continue to work, but it is highly recommended you move to the new array-based type, as this will become the standard.
244+
242245
This generates a file `user-prefs.conf`, owned by the correct Splunk user and group and located in the given directory (in this case, `/opt/splunkforwarder/etc/users/admin/user-prefs/local`).
243246

244247
Following INI format, the contents of `user-prefs.conf` will resemble the following:

0 commit comments

Comments
 (0)