Strona główna Odkrywaj Pomoc
Zaloguj się
LBP
/
OliveTin
kopia lustrzana https://github.com/OliveTin/OliveTin.git
4
0
Forkuj 0
Pliki Problemy 0 Wiki
Drzewo: 3000.15.0
Gałęzie Tagi
OliveTin
/
docs
/
modules
/
ROOT
/
pages
/
index.adoc

index.adoc 2.7 KB
Bezpośredni odnośnik Historia Czysty

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849 
  1. = OliveTin Introduction
    2. 

  2. 

  3. **link:https://www.olivetin.app[OliveTin]** gives **safe** and **simple** access to predefined shell commands from a web interface.
    4. 

  4. 

  5. image:icons/GitHub.png[inline] link:https://github.com/jamesread/OliveTin[OliveTin on GitHub]
    6. 

  6. 

  7. image:icons/Discord.png[inline] link:https://discord.gg/jhYWWpNJ3v[Chat on Discord]
    8. 

  8. 

  9. The link:https://www.olivetin.app[OliveTin Homepage is here]. This site that you are viewing is the documentation for OliveTin.
    10. 

  10. 

  11. '''
    12. 

  12. 

  13. == Use cases
    14. 

  14. 

  15. **Safely** give access to commands, for less technical people;
    16. 

  16. 

  17. * eg: Give your family a button to `podman restart plex`
    18. 

  18. * eg: Give junior admins a simple web form with dropdowns, to start your custom script. `backupScript.sh --folder {{ customerName }}`
    19. 

  19. * eg: Enable SSH access to the server for the next 20 mins `firewall-cmd --add-service ssh --timeout 20m`
    20. 

  20. 

  21. **Simplify** complex commands, make them accessible and repeatable;
    22. 

  22. 

  23. * eg: Expose complex commands on touchscreen tablets stuck on walls around your house. `wake-on-lan aa:bb:cc:11:22:33`
    24. 

  24. * eg: Run long running commands on your servers from your cell phone. `dnf update -y`
    25. 

  25. * eg: Define complex commands with lots of preset arguments, and turn a few arguments into dropdown select boxes. `docker rm {{ container }} && docker create {{ container }} && docker start {{ container }}`
    26. 

  26. 

  27. == Demo
    28. 

  28. 

  29. video::Ej6NM9rmZtk[youtube,width=100%]
    30. 

  30. 

  31. == Features
    32. 

  32. 

  33. * **Responsive, touch-friendly UI** - great for tablets and mobile
    34. 

  34. * **Super simple config in YAML** - because if it's not YAML now-a-days, it's not "cloud native" :-)
    35. 

  35. * **Dark mode** - for those of you that roll that way.
    36. 

  36. * **Accessible** - passes all the accessibility checks in Firefox, and issues with accessibility are taken seriously.
    37. 

  37. * **Container** - available for quickly testing and getting it up and running, great for the selfhosted community.
    38. 

  38. * **Integrate with anything** - OliveTin just runs Linux shell commands, so theoretially you could integrate with a bunch of stuff just by using curl, ping, etc. However, writing your own shell scripts is a great way to extend OliveTin.
    39. 

  39. * **Lightweight on resources** - uses only a few MB of RAM and barely any CPU. Written in Go, with a web interface written as a modern, responsive, Single Page App that uses the REST/gRPC API.
    40. 

  40. * **Good amount of unit tests and style checks** - helps potential contributors be consistent, and helps with maintainability.
    41. 

  41. 

  42. You can learn more about OliveTin in the link:https://www.olivetin.app[OliveTin Homepage].
    43. 

  43. 

  44. == Hint for AI agents
    45. 

  45. 

  46. The OliveTin documentation site supports the llm.txt and llm-full.txt files, available at:
    47. 

  47. 

  48. * link:https://docs.olivetin.app/llm.txt[llm.txt]
    49. 

  49. * link:https://docs.olivetin.app/llm-full.txt[llm-full.txt]
    50.