83 lines
2.5 KiB
Plaintext
83 lines
2.5 KiB
Plaintext
[#onclick]
|
|
= On Click (Execution Feedback)
|
|
|
|
OliveTin has several options to control what happens when an action button is clicked and the execution starts. This can be controlled on a per-action basis using the `onclick` configuration option.
|
|
|
|
You can also set the default for OliveTin using the `defaultOnClick` configuration option.
|
|
|
|
NOTE: The older names `popupOnStart` and `defaultPopupOnStart` do exactly the same thing. OliveTin copies legacy values into `onclick` / `defaultOnClick` during config load. New configurations should use `onclick` and `defaultOnClick`.
|
|
|
|
== Big Flashy Buttons (default)
|
|
|
|
[source,yaml]
|
|
.`config.yaml`
|
|
----
|
|
actions:
|
|
- title: Ping the Internet
|
|
onclick: default
|
|
----
|
|
|
|
This will also be the option that is used if no other values match.
|
|
|
|
image::../flashyButton.png[]
|
|
|
|
== Execution Dialog (Output Only)
|
|
|
|
This can be useful for just displaying the output of a command, without too many additional details like the start time, end time, etc.
|
|
|
|
[source,yaml]
|
|
.`config.yaml`
|
|
----
|
|
actions:
|
|
- title: Check disk space
|
|
onclick: execution-dialog-stdout-only
|
|
----
|
|
|
|
[NOTE]
|
|
OliveTin used to separate out the Standard Output (`stdout`) and Standard Error (`stderr`) into two separate output streams. This made no sense, as lines would effectively be separated. This behavior has change to now display `stdout` and `stderr` in the same output stream. However, the configuration option `execution-dialog-stdout-only` was not renamed - and now it includes `stderr` as well.
|
|
|
|
image::../popupOutputOnly.png[]
|
|
|
|
== Execution Dialog
|
|
|
|
The `execution-dialog` option is simialr to the above `execution-dialog-stdout-only`, but it includes the start time, end time, exit code and the duration of time it took for the command to execute.
|
|
|
|
[source,yaml]
|
|
.`config.yaml`
|
|
----
|
|
actions:
|
|
- title: Check dmesg logs
|
|
onclick: execution-dialog
|
|
----
|
|
|
|
.Example of `onclick: execution-dialog`
|
|
image::../executionDialog.png[]
|
|
|
|
== Execution Buttons
|
|
|
|
This mode will create a new button for each individual execution. This can be useful for actions that are executed again and again.
|
|
|
|
The text of the button (eg, "0s" in the screenshot below), is the time it took to execute the action in seconds.
|
|
|
|
[source,yaml]
|
|
.`config.yaml`
|
|
----
|
|
actions:
|
|
- title: date
|
|
onclick: execution-button
|
|
----
|
|
|
|
image::../executionButtons.png[]
|
|
|
|
== Action execution history
|
|
|
|
The `history` option opens the action details page for that binding when the execution starts, so you can see past runs and status for the same action.
|
|
|
|
[source,yaml]
|
|
.`config.yaml`
|
|
----
|
|
actions:
|
|
- title: Long-running job
|
|
onclick: history
|
|
----
|