From a545dc655d03180b982c57a0bfdcbfc6e9a91284 Mon Sep 17 00:00:00 2001 From: jamesread Date: Tue, 27 Feb 2024 11:13:10 +0000 Subject: [PATCH] deploy: 9109c78aec2bbf5d8320ff23cd073bff73ee4c24 --- _dropdown_choice_arguments.html | 2 +- _execution_feedback.html | 4 +- _exit_code_127.html | 2 +- _gpio_control_on_raspberry_pi.html | 2 +- ...ontainer_control_panel_traefik_docker.html | 2 +- _important_safety_warning.html | 2 +- _introduction_to_arguments.html | 2 +- _misc_api_calls.html | 2 +- _olivetin_api_overview.html | 2 +- _reference.html | 2 +- _run_as_different_users.html | 4 +- _security.html | 2 +- _textbox_arguments.html | 2 +- _the_actions_section.html | 2 +- _understanding_exit_codes.html | 2 +- action-container-control.html | 2 +- action-customisation.html | 7 +- action-ids.html | 362 ++++++++++++++++++ action-ping.html | 2 +- action-service.html | 2 +- action-ssh.html | 2 +- actions.html | 2 +- after-completion.html | 2 +- ansible-playbook.html | 2 +- apache-dns.html | 2 +- api-start-action.html | 22 +- api.html | 2 +- args.html | 2 +- auth-concepts.html | 2 +- auth.html | 2 +- caddy-dns.html | 2 +- caddy-path.html | 2 +- choose-package.html | 2 +- concurrency.html | 6 +- config.html | 2 +- confirmation.html | 2 +- container-dnf.html | 2 +- create-your-first-action.html | 2 +- dashboards.html | 2 +- entities-json.html | 2 +- entities-yaml.html | 2 +- entities.html | 2 +- err-fetch-buttons.html | 2 +- err-fetch-webui-settings.html | 2 +- err-js-modules-not-supported.html | 2 +- examples.html | 4 +- exec-cron.html | 2 +- exec-file-changed.html | 2 +- exec-file-created.html | 2 +- exec-on-demand.html | 2 +- exec-startup.html | 2 +- exec-webhook.html | 2 +- haproxy-dns.html | 2 +- icons.html | 4 +- index.html | 2 +- install-alpine.html | 2 +- install-archbtw.html | 2 +- install-compose.html | 2 +- install-container-vs-service.html | 2 +- install-container.html | 2 +- install-fedora.html | 2 +- install-helm.html | 2 +- install-k8s.html | 2 +- install-linuxpackage.html | 2 +- install-targz.html | 2 +- installation.html | 2 +- jwt.html | 2 +- log-levels.html | 2 +- multi-inst.html | 2 +- network-ports.html | 2 +- nginx-dns.html | 2 +- nginx-path.html | 2 +- no-puid-pgid.html | 2 +- ports.html | 2 +- powershell.html | 2 +- proxy-guide.html | 2 +- reverse-proxies.html | 2 +- snapsnots.html | 2 +- solutions.html | 2 +- sosreport.html | 2 +- support.html | 2 +- timeout.html | 4 +- timezone.html | 2 +- toggle-webui.html | 2 +- traefik-docker-compose.html | 2 +- triggers.html | 2 +- troubleshooting.html | 2 +- trusted-header.html | 2 +- update-tracking.html | 2 +- 89 files changed, 486 insertions(+), 91 deletions(-) create mode 100644 action-ids.html diff --git a/_dropdown_choice_arguments.html b/_dropdown_choice_arguments.html index f19954a05..50d09f7b6 100644 --- a/_dropdown_choice_arguments.html +++ b/_dropdown_choice_arguments.html @@ -254,7 +254,7 @@

diff --git a/_execution_feedback.html b/_execution_feedback.html index 269e2e289..033b0f172 100644 --- a/_execution_feedback.html +++ b/_execution_feedback.html @@ -297,6 +297,8 @@

OliveTin

  • 5.5. Concurrency
  • +
  • 5.6. IDs +
  • 6. Action examples @@ -402,7 +404,7 @@

    diff --git a/_exit_code_127.html b/_exit_code_127.html index a3e2b4afa..5236ec39a 100644 --- a/_exit_code_127.html +++ b/_exit_code_127.html @@ -224,7 +224,7 @@

    diff --git a/_gpio_control_on_raspberry_pi.html b/_gpio_control_on_raspberry_pi.html index e924e1d6a..ade97cb6a 100644 --- a/_gpio_control_on_raspberry_pi.html +++ b/_gpio_control_on_raspberry_pi.html @@ -213,7 +213,7 @@

    diff --git a/_homelab_container_control_panel_traefik_docker.html b/_homelab_container_control_panel_traefik_docker.html index 55c8d838b..853375c7b 100644 --- a/_homelab_container_control_panel_traefik_docker.html +++ b/_homelab_container_control_panel_traefik_docker.html @@ -213,7 +213,7 @@

    diff --git a/_important_safety_warning.html b/_important_safety_warning.html index 0f16c37d1..77edf831b 100644 --- a/_important_safety_warning.html +++ b/_important_safety_warning.html @@ -235,7 +235,7 @@

    diff --git a/_introduction_to_arguments.html b/_introduction_to_arguments.html index 16b8fdd74..93820b0ce 100644 --- a/_introduction_to_arguments.html +++ b/_introduction_to_arguments.html @@ -238,7 +238,7 @@

    diff --git a/_misc_api_calls.html b/_misc_api_calls.html index ffa4f67e0..b5a06d2b1 100644 --- a/_misc_api_calls.html +++ b/_misc_api_calls.html @@ -237,7 +237,7 @@

    diff --git a/_olivetin_api_overview.html b/_olivetin_api_overview.html index daf524a84..6749d9c87 100644 --- a/_olivetin_api_overview.html +++ b/_olivetin_api_overview.html @@ -246,7 +246,7 @@

  • 5.5. Concurrency
  • +
  • 5.6. IDs +
  • 6. Action examples @@ -246,7 +248,7 @@

    diff --git a/_security.html b/_security.html index 82c1a2c2c..e1b03d438 100644 --- a/_security.html +++ b/_security.html @@ -246,7 +246,7 @@

    diff --git a/_textbox_arguments.html b/_textbox_arguments.html index 9db865572..ee39557d6 100644 --- a/_textbox_arguments.html +++ b/_textbox_arguments.html @@ -311,7 +311,7 @@

    diff --git a/_the_actions_section.html b/_the_actions_section.html index 7f33bd211..9a0209d46 100644 --- a/_the_actions_section.html +++ b/_the_actions_section.html @@ -217,7 +217,7 @@

    diff --git a/_understanding_exit_codes.html b/_understanding_exit_codes.html index 05fe6c3b8..36cb2f09b 100644 --- a/_understanding_exit_codes.html +++ b/_understanding_exit_codes.html @@ -246,7 +246,7 @@

    < diff --git a/action-container-control.html b/action-container-control.html index a09ed07d2..d3142d379 100644 --- a/action-container-control.html +++ b/action-container-control.html @@ -314,7 +314,7 @@

    diff --git a/action-customisation.html b/action-customisation.html index a4b9b80bb..a171da262 100644 --- a/action-customisation.html +++ b/action-customisation.html @@ -183,6 +183,8 @@

    OliveTin

  • 5.5. Concurrency
  • +
  • 5.6. IDs +
  • 6. Action examples @@ -227,6 +229,9 @@

    Concurrency

  • +
  • +

    IDs

    +
  • @@ -237,7 +242,7 @@

    diff --git a/action-ids.html b/action-ids.html new file mode 100644 index 000000000..7e12ff674 --- /dev/null +++ b/action-ids.html @@ -0,0 +1,362 @@ + + + + + + + + +OliveTin documentation + + + + + + +
    +
    +

    5.6. IDs

    +
    +

    OliveTin actions do not require IDs to be specified in the config.yaml, as most users of OliveTin start off with the Web Interface. However, if you want to use OliveTin actions via the API, then you will need to set your action IDs manually.

    +
    +
    + + + + + +
    +
    Note
    +
    +OliveTin will automatically generate a new ID for actions every time it starts up, for actions that don’t have an id: property set. +
    +
    +
    +
    +
    actions:
    +  - title: Start the reactor
    +    id: start_reactor
    +    shell: /bin/startReactor.sh
    +
    +
    +
    + +
    + + + \ No newline at end of file diff --git a/action-ping.html b/action-ping.html index 75d2e68f7..314dcc0de 100644 --- a/action-ping.html +++ b/action-ping.html @@ -253,7 +253,7 @@

    diff --git a/action-service.html b/action-service.html index eb433319c..a12eabdd4 100644 --- a/action-service.html +++ b/action-service.html @@ -374,7 +374,7 @@

    diff --git a/action-ssh.html b/action-ssh.html index 2857102e1..911011c65 100644 --- a/action-ssh.html +++ b/action-ssh.html @@ -521,7 +521,7 @@

    diff --git a/actions.html b/actions.html index 8658d2caf..eca83d32c 100644 --- a/actions.html +++ b/actions.html @@ -260,7 +260,7 @@

    diff --git a/after-completion.html b/after-completion.html index 5d6a7c555..faf533c7e 100644 --- a/after-completion.html +++ b/after-completion.html @@ -356,7 +356,7 @@

    diff --git a/ansible-playbook.html b/ansible-playbook.html index 9d026dd74..8fb3a85d8 100644 --- a/ansible-playbook.html +++ b/ansible-playbook.html @@ -373,7 +373,7 @@

    diff --git a/apache-dns.html b/apache-dns.html index 764771926..e0ed7da9f 100644 --- a/apache-dns.html +++ b/apache-dns.html @@ -356,7 +356,7 @@

    diff --git a/api-start-action.html b/api-start-action.html index 700b88347..b14167b84 100644 --- a/api-start-action.html +++ b/api-start-action.html @@ -366,7 +366,7 @@

    +
    +
    OliveTin request object structure
    +
    +
    {
    +  "actionId": "string",
    +  "arguments": [
    +    {
    +      "name": "string",
    +      "value": "string"
    +    }
    +  ],
    +  "uniqueTrackingId": "string"
    +}
    +
    +
    +

    If you need more control over the execution, then the only other option is to submit a OliveTin reqjest object, which is just a very simple JSON structure like this;

    @@ -502,7 +520,7 @@

    diff --git a/api.html b/api.html index af45fddb8..6872826ea 100644 --- a/api.html +++ b/api.html @@ -227,7 +227,7 @@

    14. A diff --git a/args.html b/args.html index f42a1252a..1cab1dbc0 100644 --- a/args.html +++ b/args.html @@ -237,7 +237,7 @@

    7. diff --git a/auth-concepts.html b/auth-concepts.html index f02ca5708..11ebe3efc 100644 --- a/auth-concepts.html +++ b/auth-concepts.html @@ -240,7 +240,7 @@

    diff --git a/auth.html b/auth.html index 065105fab..daa9652c6 100644 --- a/auth.html +++ b/auth.html @@ -230,7 +230,7 @@

    10 diff --git a/caddy-dns.html b/caddy-dns.html index 454435b60..3640c1002 100644 --- a/caddy-dns.html +++ b/caddy-dns.html @@ -347,7 +347,7 @@

    diff --git a/caddy-path.html b/caddy-path.html index 998cab0b2..ca8d74127 100644 --- a/caddy-path.html +++ b/caddy-path.html @@ -363,7 +363,7 @@

    diff --git a/choose-package.html b/choose-package.html index 47d8c1117..32cb0af11 100644 --- a/choose-package.html +++ b/choose-package.html @@ -365,7 +365,7 @@

    diff --git a/concurrency.html b/concurrency.html index 4bc8defd6..60c7eab50 100644 --- a/concurrency.html +++ b/concurrency.html @@ -297,6 +297,8 @@

    OliveTin

  • 5.5. Concurrency
  • +
  • 5.6. IDs +
  • 6. Action examples @@ -361,12 +363,12 @@

    diff --git a/config.html b/config.html index f728f6269..3a61ec944 100644 --- a/config.html +++ b/config.html @@ -390,7 +390,7 @@

    diff --git a/confirmation.html b/confirmation.html index fd90a74cf..78355c05b 100644 --- a/confirmation.html +++ b/confirmation.html @@ -238,7 +238,7 @@

    diff --git a/container-dnf.html b/container-dnf.html index c78c793d2..813ad9ca5 100644 --- a/container-dnf.html +++ b/container-dnf.html @@ -284,7 +284,7 @@

    diff --git a/create-your-first-action.html b/create-your-first-action.html index c0049d7d1..928d4a45d 100644 --- a/create-your-first-action.html +++ b/create-your-first-action.html @@ -389,7 +389,7 @@

    < diff --git a/dashboards.html b/dashboards.html index b2effeaf0..6df0d0d94 100644 --- a/dashboards.html +++ b/dashboards.html @@ -399,7 +399,7 @@

    diff --git a/entities-json.html b/entities-json.html index 0127a1e4f..72f2a3e21 100644 --- a/entities-json.html +++ b/entities-json.html @@ -334,7 +334,7 @@

    diff --git a/entities-yaml.html b/entities-yaml.html index 3459e9cc0..765baea19 100644 --- a/entities-yaml.html +++ b/entities-yaml.html @@ -344,7 +344,7 @@

    diff --git a/entities.html b/entities.html index e62e26e6a..96c14b430 100644 --- a/entities.html +++ b/entities.html @@ -364,7 +364,7 @@

    diff --git a/err-fetch-buttons.html b/err-fetch-buttons.html index f58eba157..06d0ef960 100644 --- a/err-fetch-buttons.html +++ b/err-fetch-buttons.html @@ -223,7 +223,7 @@

    diff --git a/err-fetch-webui-settings.html b/err-fetch-webui-settings.html index 1e95c950a..53ce90a03 100644 --- a/err-fetch-webui-settings.html +++ b/err-fetch-webui-settings.html @@ -229,7 +229,7 @@

    diff --git a/err-js-modules-not-supported.html b/err-js-modules-not-supported.html index d0d0a767c..cb337db44 100644 --- a/err-js-modules-not-supported.html +++ b/err-js-modules-not-supported.html @@ -229,7 +229,7 @@

    diff --git a/examples.html b/examples.html index 9d7b3848f..0cc31d099 100644 --- a/examples.html +++ b/examples.html @@ -237,12 +237,12 @@

    -

    ← Previous: Concurrency | ↑ Up: OliveTin documentation | Next: Containers - start/stop →

    +

    ← Previous: IDs | ↑ Up: OliveTin documentation | Next: Containers - start/stop →

    diff --git a/exec-cron.html b/exec-cron.html index 2fd08888f..d9900e0c0 100644 --- a/exec-cron.html +++ b/exec-cron.html @@ -380,7 +380,7 @@

    diff --git a/exec-file-changed.html b/exec-file-changed.html index c1aa5b30b..e1b8a86d6 100644 --- a/exec-file-changed.html +++ b/exec-file-changed.html @@ -350,7 +350,7 @@

    diff --git a/exec-file-created.html b/exec-file-created.html index 33cf33c58..7723148ff 100644 --- a/exec-file-created.html +++ b/exec-file-created.html @@ -350,7 +350,7 @@

    diff --git a/exec-on-demand.html b/exec-on-demand.html index 8b69abbf6..cf278b001 100644 --- a/exec-on-demand.html +++ b/exec-on-demand.html @@ -227,7 +227,7 @@

    diff --git a/exec-startup.html b/exec-startup.html index 37baca86b..9501151c2 100644 --- a/exec-startup.html +++ b/exec-startup.html @@ -252,7 +252,7 @@

    diff --git a/exec-webhook.html b/exec-webhook.html index 9f618f3ab..c698f4b29 100644 --- a/exec-webhook.html +++ b/exec-webhook.html @@ -276,7 +276,7 @@

    diff --git a/haproxy-dns.html b/haproxy-dns.html index c96a68f38..a6693381e 100644 --- a/haproxy-dns.html +++ b/haproxy-dns.html @@ -359,7 +359,7 @@

    diff --git a/icons.html b/icons.html index 8a81ac3f1..7d89de1ed 100644 --- a/icons.html +++ b/icons.html @@ -183,6 +183,8 @@

    OliveTin

  • 5.5. Concurrency
  • +
  • 5.6. IDs +
  • 6. Action examples @@ -321,7 +323,7 @@

    diff --git a/index.html b/index.html index 0ecb02080..80a4351a6 100644 --- a/index.html +++ b/index.html @@ -340,7 +340,7 @@

    Read more

    diff --git a/install-alpine.html b/install-alpine.html index aca58817c..71b43ef27 100644 --- a/install-alpine.html +++ b/install-alpine.html @@ -249,7 +249,7 @@

    diff --git a/install-archbtw.html b/install-archbtw.html index e442674b6..a38046b5a 100644 --- a/install-archbtw.html +++ b/install-archbtw.html @@ -437,7 +437,7 @@

    diff --git a/install-compose.html b/install-compose.html index 8c5303af0..cf42439dc 100644 --- a/install-compose.html +++ b/install-compose.html @@ -502,7 +502,7 @@

    diff --git a/install-container-vs-service.html b/install-container-vs-service.html index d8b9ffb52..7ed6045cf 100644 --- a/install-container-vs-service.html +++ b/install-container-vs-service.html @@ -269,7 +269,7 @@

    diff --git a/install-container.html b/install-container.html index b7c65c68f..5922ab449 100644 --- a/install-container.html +++ b/install-container.html @@ -466,7 +466,7 @@

    diff --git a/install-fedora.html b/install-fedora.html index 53bf4f7d8..ee29cdb41 100644 --- a/install-fedora.html +++ b/install-fedora.html @@ -427,7 +427,7 @@

    diff --git a/install-helm.html b/install-helm.html index c035361d2..b8b915404 100644 --- a/install-helm.html +++ b/install-helm.html @@ -273,7 +273,7 @@

    < diff --git a/install-k8s.html b/install-k8s.html index 4d670dc98..deba07cdf 100644 --- a/install-k8s.html +++ b/install-k8s.html @@ -391,7 +391,7 @@

    diff --git a/install-linuxpackage.html b/install-linuxpackage.html index 098844504..c3e2839f5 100644 --- a/install-linuxpackage.html +++ b/install-linuxpackage.html @@ -428,7 +428,7 @@

    diff --git a/install-targz.html b/install-targz.html index da77f5c26..758c3beb4 100644 --- a/install-targz.html +++ b/install-targz.html @@ -435,7 +435,7 @@

    diff --git a/installation.html b/installation.html index e201c44d7..9f8344bab 100644 --- a/installation.html +++ b/installation.html @@ -287,7 +287,7 @@

    diff --git a/jwt.html b/jwt.html index 20f7d5076..95803d13c 100644 --- a/jwt.html +++ b/jwt.html @@ -318,7 +318,7 @@

    diff --git a/log-levels.html b/log-levels.html index 8b570c532..da923407f 100644 --- a/log-levels.html +++ b/log-levels.html @@ -370,7 +370,7 @@

    diff --git a/multi-inst.html b/multi-inst.html index 7492953c5..231132f91 100644 --- a/multi-inst.html +++ b/multi-inst.html @@ -348,7 +348,7 @@

    diff --git a/network-ports.html b/network-ports.html index f5cad95ed..d74ccdf60 100644 --- a/network-ports.html +++ b/network-ports.html @@ -299,7 +299,7 @@

    diff --git a/nginx-dns.html b/nginx-dns.html index 8cc4c336b..025f2e4a3 100644 --- a/nginx-dns.html +++ b/nginx-dns.html @@ -366,7 +366,7 @@

    diff --git a/nginx-path.html b/nginx-path.html index d5de50929..65a48d0de 100644 --- a/nginx-path.html +++ b/nginx-path.html @@ -359,7 +359,7 @@

    diff --git a/no-puid-pgid.html b/no-puid-pgid.html index 7696d43a3..40a64706d 100644 --- a/no-puid-pgid.html +++ b/no-puid-pgid.html @@ -357,7 +357,7 @@

    diff --git a/ports.html b/ports.html index 77ef0f7a3..b93a52fa9 100644 --- a/ports.html +++ b/ports.html @@ -217,7 +217,7 @@

    diff --git a/powershell.html b/powershell.html index 2adef95c2..f3de71d7c 100644 --- a/powershell.html +++ b/powershell.html @@ -253,7 +253,7 @@

    diff --git a/proxy-guide.html b/proxy-guide.html index 238c61dcc..13de66933 100644 --- a/proxy-guide.html +++ b/proxy-guide.html @@ -279,7 +279,7 @@
    diff --git a/reverse-proxies.html b/reverse-proxies.html index 3bb04b0ad..2556c4da2 100644 --- a/reverse-proxies.html +++ b/reverse-proxies.html @@ -258,7 +258,7 @@

    diff --git a/snapsnots.html b/snapsnots.html index 31a5ca4f4..362d58d99 100644 --- a/snapsnots.html +++ b/snapsnots.html @@ -263,7 +263,7 @@

    diff --git a/solutions.html b/solutions.html index c1717b537..e2e4ba379 100644 --- a/solutions.html +++ b/solutions.html @@ -228,7 +228,7 @@

    diff --git a/sosreport.html b/sosreport.html index 310d9dbcd..7edf91981 100644 --- a/sosreport.html +++ b/sosreport.html @@ -277,7 +277,7 @@

    diff --git a/support.html b/support.html index 5fb675710..49851e30e 100644 --- a/support.html +++ b/support.html @@ -230,7 +230,7 @@

    diff --git a/timeout.html b/timeout.html index 0f0c71747..ea22e59c5 100644 --- a/timeout.html +++ b/timeout.html @@ -183,6 +183,8 @@

    OliveTin

  • 5.5. Concurrency
  • +
  • 5.6. IDs +
  • 6. Action examples @@ -256,7 +258,7 @@

    diff --git a/timezone.html b/timezone.html index f629031c8..96606c7d2 100644 --- a/timezone.html +++ b/timezone.html @@ -235,7 +235,7 @@

    diff --git a/toggle-webui.html b/toggle-webui.html index 9f714337e..a7e6988e6 100644 --- a/toggle-webui.html +++ b/toggle-webui.html @@ -394,7 +394,7 @@