create_your_first.adoc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435
  1. [#create-your-first-action]
  2. = Create your first action
  3. This is an example of your very first action. First of all, edit your config.yaml, and enter this YAML markup;
  4. .config.yaml
  5. [source,yaml]
  6. ----
  7. actions:
  8. - title: Say hello
  9. shell: echo "Hello!"
  10. icon: smile
  11. ----
  12. If OliveTin is running, it should popup on your dashboard like this;
  13. image::hello-world.png[]
  14. Simply click on the button to execute the shell command. You can expand the executions to view the logs.
  15. == Important considerations
  16. * The action title must be unique. If you have multiple actions with the same title, only one will be shown.
  17. == What's Next?
  18. Now that you've created your first action, here are some logical next steps:
  19. * xref:action_customization/intro.adoc[Customize your actions] - Learn how to set icons, timeouts, and other action properties
  20. * xref:args/intro.adoc[Add arguments to actions] - Make your actions interactive with user input
  21. * xref:action_examples/intro.adoc[Browse action examples] - See real-world examples for common use cases
  22. * xref:action_execution/oncron.adoc[Schedule actions] - Set up actions to run automatically on a schedule
  23. * xref:action_execution/onwebhook.adoc[Trigger actions via webhooks] - Integrate OliveTin with external systems
  24. * xref:dashboards/intro.adoc[Organize actions with dashboards] - Create custom views to organize your actions