Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 3.46 KB

README.md

File metadata and controls

73 lines (49 loc) · 3.46 KB
Raw

OliveTin for YunoHost

Integration level Working status Maintenance status

Install OliveTin with YunoHost

Read this README in other languages.

This package allows you to install OliveTin quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

OliveTin gives safe and simple access to predefined shell commands from a web interface.

Use cases

Safely give access to commands, for less technical people

  • Give your family a button to systemctl restart jellyfin
  • Give junior admins a simple web form with dropdowns, to start your custom script like backupScript.sh --folder {{ customerName }}
  • Enable SSH access to the server for the next 20 mins firewall-cmd --add-service ssh --timeout 20m

Simplify complex commands, make them accessible and repeatable

  • Expose complex commands on touchscreen tablets stuck on walls around your house. wake-on-lan aa:bb:cc:11:22:33
  • Run long running on your servers from your cell phone. apt upgrade -y

Features

  • Responsive, touch-friendly UI - great for tablets and mobile
  • Super simple config in YAML - because if it’s not YAML now-a-days, it’s not "cloud native" :-)
  • Dark mode - for those of you that roll that way.
  • Accessible - passes all the accessibility checks in Firefox, and issues with accessibility are taken seriously.
  • Container - available for quickly testing and getting it up and running, great for the selfhosted community.
  • 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 reat way to extend OliveTin.
  • 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.
  • Good amount of unit tests and style checks - helps potential contributors be consistent, and helps with maintainability.

Shipped version: 2024.11.24~ynh1

Screenshots

Screenshot of OliveTin

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/olivetin_ynh/tree/testing --debug
or
sudo yunohost app upgrade olivetin -u https://github.com/YunoHost-Apps/olivetin_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps