بدون توضیح

James Read 395691a8ef Point to the new PULL_REQUEST_TEMPLATE		5 سال پیش
.github	e0b36016aa Issues is a fine place to ask for support.	5 سال پیش
cmd	b8c3d8d8f9 gofmt	5 سال پیش
internal	37b9e2d66f Single endpoint for web+ui (Issue #4). Migrated to modern protobuf+grpc.	5 سال پیش
media	8802daafdf retook desktop screenshot, added dark	5 سال پیش
var	1b8cbbe71d Extra helpful notes in the default config file.	5 سال پیش
webui	8584ea5a08 Accessibility improvements	5 سال پیش
.dockerignore	286fa43e95 Less junk in the docker image	5 سال پیش
.gitignore	d91fddad84 dist contains the releases, ignore.	5 سال پیش
.goreleaser.yml	408b64e5b6 docker -> amd64, push	5 سال پیش
CODE_OF_CONDUCT.md	35562e5667 Create CODE_OF_CONDUCT.md	5 سال پیش
CONTRIBUTING.adoc	395691a8ef Point to the new PULL_REQUEST_TEMPLATE	5 سال پیش
Dockerfile	e18809099a fix Dockerfile RUN and USER	5 سال پیش
LICENSE	f21b38d7a6 Create LICENSE	5 سال پیش
Makefile	495bfe58b6 Clean target	5 سال پیش
OliveTin.proto	37b9e2d66f Single endpoint for web+ui (Issue #4). Migrated to modern protobuf+grpc.	5 سال پیش
OliveTin.service	0acf2cbdea /usr/local/bin as we are not building distro packages	5 سال پیش
README.md	4b36d38f62 Remove all docs, link to new docs	5 سال پیش
SECURITY.md	d19edc16c8 Create SECURITY.md	5 سال پیش
go.mod	37b9e2d66f Single endpoint for web+ui (Issue #4). Migrated to modern protobuf+grpc.	5 سال پیش
tools.go	dc76ca9a38 tools.go, not sure how this works though!	5 سال پیش

OliveTin

OliveTin is a web interface for running Linux shell commands.

Some example use cases;

Give controlled access to run shell commands to less technical folks who cannot be trusted with SSH. I use this so my family can podman restart plex without asking me, and without giving them shell access!
Great for home automation tablets stuck on walls around your house - I use this to turn Hue lights on and off for example.
Sometimes SSH access isn't possible to a server, or you are feeling too lazy to type a long command you run regularly! I use this to send Wake on Lan commands to servers around my house.

Join the community on Discord.

YouTube video demo (6 mins)

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 great 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.

Screenshots

Desktop web browser;

Desktop web browser (dark mode);

Mobile screen size (responsive layout);

Documentation

All documentation can be found at http://olivetin.app . This includes installation and usage guide, etc.

Example `config.yaml`

Put this config.yaml in /etc/OliveTin/ if you're running a standard service, or mount it at /config if running in a container.

listenAddressWebUI: 0.0.0.0:1337 # Listen on all addresses available, port 1337
logLevel: "INFO"
actions: 
- title: Restart Plex
  icon: smile
  shell: docker restart plex
  
  # This will send 1 ping 
- title: Ping Google.com
  shell: ping google.com -c 1
  
  # Restart lightdm on host "overseer"
- title: restart lightdm
  icon: poop
  shell: ssh root@overseer 'service lightdm restart'

A full example config can be found at in this repository - config.yaml.

README.md