nav.adoc 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. * xref:install/intro.adoc[Installation Guide]
  2. *** Linux
  3. **** xref:install/container_vs_service.adoc[Containers or Service?]
  4. **** Linux Service
  5. ***** xref:install/linux_fedora.adoc[Fedora Linux]
  6. ***** xref:install/linux_alpine.adoc[Alpine Linux]
  7. ***** xref:install/linux_manjaro.adoc[Manjaro Linux]
  8. ***** xref:install/linux_arch.adoc[Arch Linux]
  9. ***** xref:install/linux_rpm.adoc[Generic .rpm based Linux]
  10. ***** xref:install/linux_deb.adoc[Generic .deb based Linux]
  11. ***** xref:install/targz.adoc[.tar.gz Install (manual)]
  12. **** xref:install/container.adoc[Linux Container]
  13. ***** xref:install/podmandocker.adoc[Docker or Podman]
  14. ***** xref:install/docker_compose.adoc[Docker Compose]
  15. ***** xref:install/helm.adoc[Kubernetes with Helm]
  16. ***** xref:install/k8s.adoc[Kubernetes with Manifests]
  17. *** xref:install/bsd.adoc[BSD]
  18. *** xref:install/windows.adoc[Windows]
  19. **** xref:install/windows_service.adoc[Windows Service]
  20. *** xref:install/macos.adoc[macOS Desktop]
  21. *** xref:install/macos_service.adoc[macOS Service]
  22. *** xref:install/choose_package.adoc[All download options]
  23. * Upgrade Guide
  24. ** xref:upgrade/2k3k.adoc[Understanding 2k vs 3k]
  25. ** xref:upgrade/upgrade_notes.adoc[Updates Notes]
  26. ** xref:upgrade/github_latest.adoc[Warning: GitHub Latest]
  27. ** xref:reference/updateChecks.adoc[Update Checks]
  28. ** xref:reference/updateTracking.adoc[Update Tracking (legacy)]
  29. * xref:config.adoc[Configuration]
  30. * xref:reverse-proxies/intro.adoc[Reverse Proxies]
  31. ** xref:reverse-proxies/apache.adoc[Apache]
  32. ** xref:reverse-proxies/caddy.adoc[Caddy]
  33. ** xref:reverse-proxies/haproxy.adoc[HAProxy]
  34. ** xref:reverse-proxies/nginx.adoc[Nginx]
  35. ** xref:reverse-proxies/nginx_proxy_manager.adoc[Nginx Proxy Manager]
  36. ** xref:reverse-proxies/traefik.adoc[Traefik]
  37. * Action Buttons
  38. ** xref:action_buttons/layout.adoc[Layout]
  39. ** xref:action_buttons/create_your_first.adoc[Create your first action]
  40. * Action Execution
  41. ** xref:action_execution/shellvsexec.adoc[Shell vs Exec]
  42. ** xref:action_execution/ondemand.adoc[Execute on click]
  43. ** xref:action_execution/oncron.adoc[Execute on schedule (cron)]
  44. ** xref:action_execution/onstartup.adoc[Execute on startup]
  45. ** xref:action_execution/onwebhook.adoc[Execute on webhook]
  46. *** xref:action_execution/onwebhook_github.adoc[GitHub Webhooks]
  47. ** xref:action_execution/onfilecreated.adoc[Execute on file created]
  48. ** xref:action_execution/onfilechanged.adoc[Execute on file changed]
  49. ** xref:action_execution/oncalendar.adoc[Execute on calendar file]
  50. ** xref:action_execution/aftercompletion.adoc[Execute after completion]
  51. ** xref:action_execution/triggers.adoc[Triggers]
  52. * xref:action_customization/intro.adoc[Action Customization]
  53. ** xref:action_customization/icons.adoc[Icons]
  54. ** xref:action_customization/timeouts.adoc[Timeouts]
  55. ** xref:action_customization/users.adoc[Users]
  56. ** xref:action_customization/concurrency.adoc[Concurrency]
  57. ** xref:action_customization/ratelimiting.adoc[Rate Limiting]
  58. ** xref:action_customization/enabledExpression.adoc[Enabled Expression]
  59. ** xref:action_customization/ids.adoc[IDs]
  60. * xref:action_examples/intro.adoc[Action Examples]
  61. ** xref:action_examples/containers.adoc[Containers - start/stop]
  62. *** xref:action_examples/docker-proxy.adoc[Docker control, via proxy]
  63. ** xref:action_examples/systemd_service.adoc[Systemd Service]
  64. ** xref:action_examples/ping.adoc[Ping]
  65. ** xref:action_examples/ssh-easy.adoc[SSH (easy)]
  66. ** xref:action_examples/ssh-manual.adoc[SSH (manual)]
  67. ** xref:action_examples/powershell.adoc[Powershell]
  68. ** xref:action_examples/ansible.adoc[Ansible]
  69. * xref:args/intro.adoc[Arguments]
  70. ** xref:args/safety.adoc[Safety]
  71. ** xref:args/types.adoc[Types]
  72. ** xref:args/input.adoc[Input]
  73. ** xref:args/regex.adoc[Input: Regex]
  74. ** xref:args/password.adoc[Input: Password]
  75. ** xref:args/input_checkbox.adoc[Input: Checkbox/Boolean]
  76. ** xref:args/input_dropdown.adoc[Input: Dropdown]
  77. ** xref:args/input_datetime.adoc[Input: Date & Time]
  78. ** xref:args/input_confirmation.adoc[Input: Confirmation]
  79. ** xref:args/input_textarea.adoc[Input: Textarea]
  80. ** xref:args/suggestions.adoc[Suggestions]
  81. ** xref:args/env.adoc[Environment Variables]
  82. ** xref:args/templates.adoc[Templates]
  83. * xref:dashboards/intro.adoc[Dashboards]
  84. ** xref:dashboards/examples.adoc[Examples]
  85. ** xref:dashboards/actions.adoc[Actions (Linked)]
  86. ** xref:dashboards/inline-actions.adoc[Actions (Inline)]
  87. ** xref:dashboards/css.adoc[Change component style]
  88. ** xref:dashboards/2-fieldsets.adoc[Fieldsets]
  89. ** xref:dashboards/3-folders.adoc[Folders]
  90. ** xref:dashboards/4-displays.adoc[Displays]
  91. ** xref:dashboards/faq-display-hyperlinks.adoc[Hyperlinks (Displays)]
  92. ** xref:dashboards/5-output-views.adoc[Output Views]
  93. ** xref:dashboards/entity-directories.adoc[Entity Directories]
  94. * xref:logs/intro.adoc[Logs]
  95. ** xref:logs/actions.adoc[Action logs]
  96. ** xref:logs/calendar.adoc[Calendar view]
  97. ** xref:logs/queue.adoc[Queue view]
  98. ** xref:logs/saving.adoc[Saving logs]
  99. * xref:entities/intro.adoc[Entities]
  100. ** xref:entities/examples.adoc[Examples]
  101. ** xref:entities/yaml.adoc[YAML Entity Files]
  102. ** xref:entities/json.adoc[JSON Entity Files]
  103. * xref:security/concepts.adoc[Security]
  104. ** xref:security/acl.adoc[Access Control Lists]
  105. ** xref:security/local.adoc[Local Users Authorization]
  106. ** xref:security/api_keys.adoc[API Keys]
  107. ** xref:security/trusted_header.adoc[Trusted Header Authorization]
  108. ** xref:security/jwt.adoc[JWT Authorization]
  109. *** xref:security/jwt_keys.adoc[JWT with Keys]
  110. *** xref:security/jwt_hmac.adoc[JWT with HMAC]
  111. ** xref:security/oauth2.adoc[OAuth2]
  112. *** xref:security/oauth2_authentik.adoc[OAuth2 with Authentik]
  113. *** xref:security/oauth2_authelia.adoc[OAuth2 with Authelia]
  114. *** xref:security/oauth2_pocketid.adoc[OAuth2 with Pocket ID]
  115. ** xref:security/examples.adoc[Security examples]
  116. *** xref:security/example_login_required.adoc[Example: Login Required]
  117. *** xref:security/example_some_admin_actions.adoc[Example: Some actions require admin]
  118. ** xref:security/design_choices.adoc[Security Design & Hardening Recommendations]
  119. ** xref:security/content_security_policy.adoc[Content Security Policy headers]
  120. * Integrations
  121. ** xref:integrations/homeassistant-integration.adoc[Home Assistant (HACS Integration)]
  122. ** xref:integrations/homeassistant.adoc[Home Assistant (REST)]
  123. ** xref:integrations/stream-deck.adoc[Stream-Deck]
  124. ** xref:integrations/n8n.adoc[n8n]
  125. ** xref:integrations/mcp.adoc[MCP Servers]
  126. ** xref:security/oauth2_authentik.adoc[Authentik]
  127. ** xref:security/oauth2_pocketid.adoc[Pocket ID]
  128. ** xref:reverse-proxies/intro.adoc[Reverse Proxies]
  129. * xref:solutions/intro.adoc[Solutions]
  130. ** xref:security/examples.adoc[Security examples]
  131. ** xref:solutions/on-git-push/index.adoc[Self hosted GitOps]
  132. ** xref:solutions/container-control-panel/index.adoc[Container Control Panel]
  133. ** xref:solutions/systemd-control-panel/index.adoc[Systemd Control Panel]
  134. ** xref:solutions/heating-control-panel/index.adoc[Heating Control Panel]
  135. ** xref:solutions/human-in-the-control-loop/index.adoc[Human in the Control Loop]
  136. ** xref:solutions/k8s-control-panel-hosted/index.adoc[Kubernetes Control Panel (hosted)]
  137. ** xref:solutions/primitive-password/index.adoc[Primitive Password Protection]
  138. ** xref:solutions/wol/index.adoc[Wake on LAN]
  139. ** xref:solutions/cloudflare_access_tunnel/index.adoc[Cloudflare Access & Tunnels]
  140. ** xref:solutions/directory-actions/index.adoc[Directory Actions]
  141. * xref:advanced_configuration/intro.adoc[Advanced Configuration]
  142. ** xref:advanced_configuration/logs.adoc[Logging - Application]
  143. ** xref:advanced_configuration/diagnostics.adoc[Diagnostics]
  144. ** xref:advanced_configuration/config_envs.adoc[Config Envs]
  145. ** xref:advanced_configuration/ports.adoc[Ports]
  146. ** xref:advanced_configuration/stylemods.adoc[Style Mods]
  147. ** xref:advanced_configuration/prometheus.adoc[Prometheus]
  148. ** xref:advanced_configuration/timezones.adoc[Timezones]
  149. ** xref:advanced_configuration/webui.adoc[Customize the WebUI]
  150. * Reference
  151. ** xref:reference/network-ports.adoc[Network Ports]
  152. ** xref:reference/exitCodes.adoc[Exit Codes]
  153. ** xref:reference/containerInstallPackages.adoc[Install packages in containers]
  154. ** xref:reference/reference_snapshots.adoc[Snapshots]
  155. ** xref:reference/reference_themes_for_users.adoc[Themes (for users)]
  156. ** xref:reference/reference_themes_for_developers.adoc[Themes (for developers)]
  157. ** xref:reference/contribute.adoc[Contribute]
  158. ** xref:reference/donations_and_sponsorship.adoc[Donations & Sponsorship]
  159. ** xref:reference/multiple_instances.adoc[Multiple Instances]
  160. ** xref:reference/release_policy.adoc[Release Policy]
  161. ** xref:reference/includes.adoc[Includes]
  162. * Troubleshooting
  163. ** xref:troubleshooting/wheretofindhelp.adoc[Where to find help]
  164. ** xref:troubleshooting/browser-console-logs.adoc[Browser console logs (WebUI)]
  165. ** xref:troubleshooting/service-logs.adoc[Service logs (OliveTin process)]
  166. ** xref:troubleshooting/server-diagnostics.adoc[Server diagnostics]
  167. ** xref:troubleshooting/puid-pgid.adoc[No PUID/PGID support]
  168. ** xref:troubleshooting/log-debug-options.adoc[Log Debug Options]
  169. ** xref:troubleshooting/exit127.adoc[Exit Code 127]
  170. ** xref:troubleshooting/err-fetch-webui-settings.adoc[Error: WebUI Settings]
  171. ** xref:troubleshooting/err-fetch-buttons.adoc[Error: Fetch Buttons]
  172. ** xref:troubleshooting/err-js-modules-not-supported.adoc[Error: JS Modules not supported]
  173. ** xref:troubleshooting/err-websocket-connection.adoc[Error: Websocket Connection]
  174. ** xref:troubleshooting/err-webui-mismatch.adoc[Error: WebUI Version Mismatch]
  175. ** xref:troubleshooting/advanced.adoc[Advanced Troubleshooting]
  176. * xref:api/intro.adoc[API]
  177. ** xref:api/start_action.adoc[Start Actions from the API]
  178. *** xref:api/method_StartAction.adoc[StartAction]
  179. *** xref:api/method_StartActionByGet.adoc[StartActionByGet]
  180. *** xref:api/method_StartActionAndWait.adoc[StartActionAndWait]
  181. *** xref:api/method_StartActionByGetAndWait.adoc[StartActionByGetAndWait]
  182. ** xref:api/misc.adoc[Misc API calls]
  183. ** xref:api/login.adoc[Local user login via the API]