175 lines
9.3 KiB
Plaintext
175 lines
9.3 KiB
Plaintext
* xref:install/intro.adoc[Installation Guide]
|
|
*** Linux
|
|
**** xref:install/container_vs_service.adoc[Containers or Service?]
|
|
**** Linux Service
|
|
***** xref:install/linux_fedora.adoc[Fedora Linux]
|
|
***** xref:install/linux_alpine.adoc[Alpine Linux]
|
|
***** xref:install/linux_manjaro.adoc[Manjaro Linux]
|
|
***** xref:install/linux_arch.adoc[Arch Linux]
|
|
***** xref:install/linux_rpm.adoc[Generic .rpm based Linux]
|
|
***** xref:install/linux_deb.adoc[Generic .deb based Linux]
|
|
***** xref:install/targz.adoc[.tar.gz Install (manual)]
|
|
**** xref:install/container.adoc[Linux Container]
|
|
***** xref:install/podmandocker.adoc[Docker or Podman]
|
|
***** xref:install/docker_compose.adoc[Docker Compose]
|
|
***** xref:install/helm.adoc[Kubernetes with Helm]
|
|
***** xref:install/k8s.adoc[Kubernetes with Manifests]
|
|
*** xref:install/bsd.adoc[BSD]
|
|
*** xref:install/windows.adoc[Windows]
|
|
**** xref:install/windows_service.adoc[Windows Service]
|
|
*** xref:install/macos.adoc[MacOS]
|
|
*** xref:install/choose_package.adoc[All download options]
|
|
* Upgrade Guide
|
|
** xref:upgrade/2k3k.adoc[Understanding 2k vs 3k]
|
|
** xref:upgrade/upgrade_notes.adoc[Updates Notes]
|
|
** xref:upgrade/github_latest.adoc[Warning: GitHub Latest]
|
|
** xref:reference/updateChecks.adoc[Update Checks]
|
|
** xref:reference/updateTracking.adoc[Update Tracking (legacy)]
|
|
* xref:config.adoc[Configuration]
|
|
* xref:reverse-proxies/intro.adoc[Reverse Proxies]
|
|
** xref:reverse-proxies/apache.adoc[Apache]
|
|
** xref:reverse-proxies/caddy.adoc[Caddy]
|
|
** xref:reverse-proxies/haproxy.adoc[HAProxy]
|
|
** xref:reverse-proxies/nginx.adoc[Nginx]
|
|
** xref:reverse-proxies/nginx_proxy_manager.adoc[Nginx Proxy Manager]
|
|
** xref:reverse-proxies/traefik.adoc[Traefik]
|
|
* Action Execution
|
|
** xref:action_execution/create_your_first.adoc[Create your first action]
|
|
** xref:action_execution/shellvsexec.adoc[Shell vs Exec]
|
|
** xref:action_execution/ondemand.adoc[Execute on demand]
|
|
** xref:action_execution/oncron.adoc[Execute on schedule (cron)]
|
|
** xref:action_execution/onstartup.adoc[Execute on startup]
|
|
** xref:action_execution/onwebhook.adoc[Execute on webhook]
|
|
*** xref:action_execution/onwebhook_github.adoc[GitHub Webhooks]
|
|
** xref:action_execution/onfilecreated.adoc[Execute on file created]
|
|
** xref:action_execution/onfilechanged.adoc[Execute on file changed]
|
|
** xref:action_execution/oncalendar.adoc[Execute on calendar file]
|
|
** xref:action_execution/aftercompletion.adoc[Execute after completion]
|
|
** xref:action_execution/triggers.adoc[Triggers]
|
|
* xref:action_customization/intro.adoc[Action Customization]
|
|
** xref:action_customization/popuponstart.adoc[Popup on start]
|
|
** xref:action_customization/icons.adoc[Icons]
|
|
** xref:action_customization/timeouts.adoc[Timeouts]
|
|
** xref:action_customization/users.adoc[Users]
|
|
** xref:action_customization/concurrency.adoc[Concurrency]
|
|
** xref:action_customization/ratelimiting.adoc[Rate Limiting]
|
|
** xref:action_customization/enabledExpression.adoc[Enabled Expression]
|
|
** xref:action_customization/ids.adoc[IDs]
|
|
** xref:action_customization/savelogs.adoc[Save Logs]
|
|
* xref:action_examples/intro.adoc[Action Examples]
|
|
** xref:action_examples/containers.adoc[Containers - start/stop]
|
|
*** xref:action_examples/docker-proxy.adoc[Docker control, via proxy]
|
|
** xref:action_examples/systemd_service.adoc[Systemd Service]
|
|
** xref:action_examples/ping.adoc[Ping]
|
|
** xref:action_examples/ssh-easy.adoc[SSH (easy)]
|
|
** xref:action_examples/ssh-manual.adoc[SSH (manual)]
|
|
** xref:action_examples/powershell.adoc[Powershell]
|
|
** xref:action_examples/ansible.adoc[Ansible]
|
|
* xref:args/intro.adoc[Arguments]
|
|
** xref:args/safety.adoc[Safety]
|
|
** xref:args/types.adoc[Types]
|
|
** xref:args/input.adoc[Input]
|
|
** xref:args/regex.adoc[Input: Regex]
|
|
** xref:args/password.adoc[Input: Password]
|
|
** xref:args/input_checkbox.adoc[Input: Checkbox/Boolean]
|
|
** xref:args/input_dropdown.adoc[Input: Dropdown]
|
|
** xref:args/input_datetime.adoc[Input: Date & Time]
|
|
** xref:args/input_confirmation.adoc[Input: Confirmation]
|
|
** xref:args/input_textarea.adoc[Input: Textarea]
|
|
** xref:args/suggestions.adoc[Suggestions]
|
|
** xref:args/env.adoc[Environment Variables]
|
|
* xref:dashboards/intro.adoc[Dashboards]
|
|
** xref:dashboards/examples.adoc[Examples]
|
|
** xref:dashboards/actions.adoc[Actions (Linked)]
|
|
** xref:dashboards/inline-actions.adoc[Actions (Inline)]
|
|
** xref:dashboards/css.adoc[Change component style]
|
|
** xref:dashboards/2-fieldsets.adoc[Fieldsets]
|
|
** xref:dashboards/3-folders.adoc[Folders]
|
|
** xref:dashboards/4-displays.adoc[Displays]
|
|
** xref:dashboards/5-output-views.adoc[Output Views]
|
|
** xref:dashboards/entity-directories.adoc[Entity Directories]
|
|
* xref:entities/intro.adoc[Entities]
|
|
** xref:entities/examples.adoc[Examples]
|
|
** xref:entities/yaml.adoc[YAML Entity Files]
|
|
** xref:entities/json.adoc[JSON Entity Files]
|
|
* xref:security/concepts.adoc[Security]
|
|
** xref:security/acl.adoc[Access Control Lists]
|
|
** xref:security/local.adoc[Local Users Authorization]
|
|
** xref:security/trusted_header.adoc[Trusted Header Authorization]
|
|
** xref:security/jwt.adoc[JWT Authorization]
|
|
*** xref:security/jwt_keys.adoc[JWT with Keys]
|
|
*** xref:security/jwt_hmac.adoc[JWT with HMAC]
|
|
** xref:security/oauth2.adoc[OAuth2]
|
|
*** xref:security/oauth2_authentik.adoc[OAuth2 with Authentik]
|
|
*** xref:security/oauth2_authelia.adoc[OAuth2 with Authelia]
|
|
*** xref:security/oauth2_pocketid.adoc[OAuth2 with Pocket ID]
|
|
** xref:security/examples.adoc[Security examples]
|
|
*** xref:security/example_login_required.adoc[Example: Login Required]
|
|
*** xref:security/example_some_admin_actions.adoc[Example: Some actions require admin]
|
|
** xref:security/design_choices.adoc[Security Design & Hardening Recommendations]
|
|
** xref:security/content_security_policy.adoc[Content Security Policy headers]
|
|
* Integrations
|
|
** xref:integrations/homeassistant-integration.adoc[Home Assistant (HACS Integration)]
|
|
** xref:integrations/homeassistant.adoc[Home Assistant (REST)]
|
|
** xref:integrations/stream-deck.adoc[Stream-Deck]
|
|
** xref:integrations/n8n.adoc[n8n]
|
|
** xref:security/oauth2_authentik.adoc[Authentik]
|
|
** xref:security/oauth2_pocketid.adoc[Pocket ID]
|
|
** xref:reverse-proxies/intro.adoc[Reverse Proxies]
|
|
* xref:solutions/intro.adoc[Solutions]
|
|
** xref:security/examples.adoc[Security examples]
|
|
** xref:solutions/on-git-push/index.adoc[Self hosted GitOps]
|
|
** xref:solutions/container-control-panel/index.adoc[Container Control Panel]
|
|
** xref:solutions/systemd-control-panel/index.adoc[Systemd Control Panel]
|
|
** xref:solutions/heating-control-panel/index.adoc[Heating Control Panel]
|
|
** xref:solutions/k8s-control-panel-hosted/index.adoc[Kubernetes Control Panel (hosted)]
|
|
** xref:solutions/primitive-password/index.adoc[Primitive Password Protection]
|
|
** xref:solutions/wol/index.adoc[Wake on LAN]
|
|
** xref:solutions/cloudflare_access_tunnel/index.adoc[Cloudflare Access & Tunnels]
|
|
** xref:solutions/directory-actions/index.adoc[Directory Actions]
|
|
* xref:advanced_configuration/intro.adoc[Advanced Configuration]
|
|
** xref:advanced_configuration/logs.adoc[Logging - Application]
|
|
** xref:advanced_configuration/logs-actions.adoc[Logging - Actions]
|
|
** xref:advanced_configuration/logs-calendar.adoc[Logs Calendar View]
|
|
** xref:advanced_configuration/diagnostics.adoc[Diagnostics]
|
|
** xref:advanced_configuration/config_envs.adoc[Config Envs]
|
|
** xref:advanced_configuration/ports.adoc[Ports]
|
|
** xref:advanced_configuration/stylemods.adoc[Style Mods]
|
|
** xref:advanced_configuration/prometheus.adoc[Prometheus]
|
|
** xref:advanced_configuration/timezones.adoc[Timezones]
|
|
** xref:advanced_configuration/webui.adoc[Customize the WebUI]
|
|
* Reference
|
|
** xref:reference/network-ports.adoc[Network Ports]
|
|
** xref:reference/exitCodes.adoc[Exit Codes]
|
|
** xref:reference/containerInstallPackages.adoc[Install packages in containers]
|
|
** xref:reference/reference_snapshots.adoc[Snapshots]
|
|
** xref:reference/reference_themes_for_users.adoc[Themes (for users)]
|
|
** xref:reference/reference_themes_for_developers.adoc[Themes (for developers)]
|
|
** xref:reference/contribute.adoc[Contribute]
|
|
** xref:reference/donations_and_sponsorship.adoc[Donations & Sponsorship]
|
|
** xref:reference/multiple_instances.adoc[Multiple Instances]
|
|
** xref:reference/release_policy.adoc[Release Policy]
|
|
** xref:reference/includes.adoc[Includes]
|
|
* Troubleshooting
|
|
** xref:troubleshooting/wheretofindhelp.adoc[Where to find help]
|
|
** xref:troubleshooting/browser-console-logs.adoc[Browser console logs (WebUI)]
|
|
** xref:troubleshooting/service-logs.adoc[Service logs (OliveTin process)]
|
|
** xref:troubleshooting/server-diagnostics.adoc[Server diagnostics]
|
|
** xref:troubleshooting/puid-pgid.adoc[No PUID/PGID support]
|
|
** xref:troubleshooting/log-debug-options.adoc[Log Debug Options]
|
|
** xref:troubleshooting/exit127.adoc[Exit Code 127]
|
|
** xref:troubleshooting/err-fetch-webui-settings.adoc[Error: WebUI Settings]
|
|
** xref:troubleshooting/err-fetch-buttons.adoc[Error: Fetch Buttons]
|
|
** xref:troubleshooting/err-js-modules-not-supported.adoc[Error: JS Modules not supported]
|
|
** xref:troubleshooting/err-websocket-connection.adoc[Error: Websocket Connection]
|
|
** xref:troubleshooting/err-webui-mismatch.adoc[Error: WebUI Version Mismatch]
|
|
** xref:troubleshooting/advanced.adoc[Advanced Troubleshooting]
|
|
* xref:api/intro.adoc[API]
|
|
** xref:api/start_action.adoc[Start Actions from the API]
|
|
*** xref:api/method_StartAction.adoc[StartAction]
|
|
*** xref:api/method_StartActionByGet.adoc[StartActionByGet]
|
|
*** xref:api/method_StartActionAndWait.adoc[StartActionAndWait]
|
|
*** xref:api/method_StartActionByGetAndWait.adoc[StartActionByGetAndWait]
|
|
** xref:api/misc.adoc[Misc API calls]
|
|
** xref:api/login.adoc[Local user login via the API]
|