Просмотр исходного кода

docs: document webUIDir and list community web UIs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Damian Kujtkowski 1 день назад
Родитель
Сommit
a1e2a17681

+ 19 - 0
docs/modules/ROOT/pages/advanced_configuration/webui.adoc

@@ -160,6 +160,25 @@ When enabled, the header shows a search control that can jump to actions, dashbo
 
 Other `features.*` flags follow the same pattern: typed booleans under `features`, default false, exposed on Init for the web UI, and treated as alpha until graduated.
 
+[#replace-webui]
+== Replace the web UI (`webUIDir`)
+
+Themes and custom JavaScript change the default web UI. If you want a completely different interface, you can point OliveTin at another directory of static files with `webUIDir`. OliveTin serves `index.html` and everything next to it from that directory, while the API stays on the same origin, so authentication and ACLs apply unchanged.
+
+.`config.yaml`
+[source,yaml]
+----
+webUIDir: /etc/OliveTin/my-webui/
+----
+
+Restart OliveTin after changing `webUIDir`. To go back to the default web UI, remove the option.
+
+A replacement web UI only talks to the OliveTin API, so it needs to be kept compatible with the version of OliveTin you run.
+
+=== Community web UIs
+
+* https://github.com/DabuSoft-pl/olivetin-lamp[Lamp] - a phone-friendly web UI, with "hold to run" confirmations, live output and an optional status screen built from entities.
+
 == Custom CSS (with a custom theme)
 
 You can customize OliveTin with themes, but it's also possible to write your on very simple theme that contains just a few CSS rules to change the look and feel of OliveTin. This is very useful if you just want to change the colours of OliveTin, or hide a few elements.

+ 1 - 1
docs/modules/ROOT/pages/config.adoc

@@ -131,7 +131,7 @@ All configuration options are covered in the solution sections
 |===
 | Option | Description | Default | Live Reloadable | Documentation
 
-| `webUIDir` | The directory to serve the web UI from. | Calculated at runtime. | Requires Restart | -
+| `webUIDir` | The directory to serve the web UI from. | Calculated at runtime. | Requires Restart | xref:advanced_configuration/webui.adoc#replace-webui[Replace the web UI]
 | `cronSupportForSeconds` | Whether or not to support seconds in cron expressions. | `false` | Requires Restart | xref:action_execution/oncron.adoc[Cron]
 | `saveLogs` | Whether or not to save logs to disk. | `[]` | Requires Restart | xref:logs/saving.adoc[Save Logs]
 | `serviceLogs` | Windows process log directory (`serviceLogs.directory`). | `%ProgramData%\OliveTin\logs\` on Windows | Requires Restart | xref:install/windows_service.adoc#windows-service-logs[Windows service logs]