kibana/docs/reference/configuration-reference
Dima Arnautov 6722f142a4
Support local file path for xpack.productDocBase.artifactRepositoryUrl (#217046)
## Summary

Closes https://github.com/elastic/kibana/issues/216583

Adds support for a local file path in
`xpack.productDocBase.artifactRepositoryUrl` setting.
If local path with `file://` protocol is provided, it has to contain a
path to a directory with the artifacts and the `index.xml` file.

#### How to test 

1. Download the XML and zip files from
https://kibana-knowledge-base-artifacts.elastic.co
2. Create a folder, e.g. `mkdir /Users/<my_user>/test_artifacts` and
place all the files there. The XML file has to be called `index.xml`
3. Add `xpack.productDocBase.artifactRepositoryUrl:
'file:///Users/<my_user>/test_artifacts'` to your `kibana.dev.yml`
4. Go to `/app/management/kibana/observabilityAiAssistantManagement` in
Kibana and install Elastic documentation
5. Kibana dev server should report `[2025-04-07T14:05:10.640+02:00][INFO
][plugins.productDocBase.package-installer] Documentation installation
successful for product [security] and version [8.17]`
6. Check `data/ai-kb-artifacts` folder in your Kibana repo, it should
contain zip files with docs

### Checklist

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
2025-04-14 15:27:41 +02:00
..
ai-assistant-settings.md Support local file path for xpack.productDocBase.artifactRepositoryUrl (#217046) 2025-04-14 15:27:41 +02:00
alerting-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
apm-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
banner-settings.md Custom link colour option for top banner (#214241) 2025-03-25 20:26:35 +01:00
cases-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
fleet-settings.md [docs] Remove reliance on temporary redirects (#216315) 2025-03-28 10:54:32 -05:00
general-settings.md [docs] Remove reliance on temporary redirects part 2 (#216362) 2025-03-31 07:43:40 +00:00
internationalization-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
logging-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
logs-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
map-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
metrics-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
monitoring-settings.md [docs] Remove reliance on temporary redirects part 2 (#216362) 2025-03-31 07:43:40 +00:00
reporting-settings.md [docs] Remove reliance on temporary redirects (#216315) 2025-03-28 10:54:32 -05:00
search-sessions-settings.md [Docs] Settings - Specify that search sessions are disabled by default in 9.0 (#216091) 2025-03-27 09:44:06 +01:00
security-settings.md [docs] Remove reliance on temporary redirects part 2 (#216362) 2025-03-31 07:43:40 +00:00
spaces-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
task-manager-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
telemetry-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00
url-drilldown-settings.md [DOCS] Consolidate and clean up Kibana settings (part 1) (#214934) 2025-03-18 11:37:40 -07:00