Tidak Ada Deskripsi

147 Rilis

James Read ff5d60a2dc Add snapshot badge		4 tahun lalu
.github	2f6a975bb3 Update workflows	4 tahun lalu
cmd	91ce4e93a2 codestyle, fmt, unit tests, etc	4 tahun lalu
integration-tests	4b2ef44959 remove old target	4 tahun lalu
internal	b3b5b6fe60 codestyle stuff	4 tahun lalu
media	796285c37d Updated screenshots in README	4 tahun lalu
var	b029c7f0ac An init script (!), and ignore bins in root	4 tahun lalu
webui	30d681690a #6 - task arguments, that was a lot of work!	4 tahun lalu
.dockerignore	286fa43e95 Less junk in the docker image	5 tahun lalu
.gitignore	b029c7f0ac An init script (!), and ignore bins in root	4 tahun lalu
.goreleaser.yml	4e8f20e1e6 dont need to run make grpc on every build	4 tahun lalu
CODE_OF_CONDUCT.md	35562e5667 Create CODE_OF_CONDUCT.md	5 tahun lalu
CONTRIBUTING.adoc	761160918d Update CONTRIBUTING.adoc	4 tahun lalu
Dockerfile	1ae4e6ac54 It seems specifying the GID like this isnt correct	4 tahun lalu
Jenkinsfile	ff45320cbe checkout scm!	4 tahun lalu
LICENSE	f21b38d7a6 Create LICENSE	5 tahun lalu
Makefile	41dc1d9b72 remove errcheck	4 tahun lalu
OliveTin.proto	30d681690a #6 - task arguments, that was a lot of work!	4 tahun lalu
OliveTin.service	0acf2cbdea /usr/local/bin as we are not building distro packages	5 tahun lalu
README.md	ff5d60a2dc Add snapshot badge	4 tahun lalu
SECURITY.md	d19edc16c8 Create SECURITY.md	5 tahun lalu
buf.gen.yaml	b5572fa128 Migrate from protoc -> buf	4 tahun lalu
buf.lock	b5572fa128 Migrate from protoc -> buf	4 tahun lalu
buf.yaml	b5572fa128 Migrate from protoc -> buf	4 tahun lalu
config.yaml	666d29cd03 Consolidated configs	4 tahun lalu
go.mod	b3b5b6fe60 codestyle stuff	4 tahun lalu
go.sum	b3b5b6fe60 codestyle stuff	4 tahun lalu
tools.go	b3b5b6fe60 codestyle stuff	4 tahun lalu

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://docs.olivetin.app . This includes installation and usage guide, etc.

Quickstart reference for `config.yaml`

This is a quick example of config.yaml - but again, lots of documentation for how to write your config.yaml can be found at the documentation site.

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

# Listen on all addresses available, port 1337
listenAddressSingleHTTPFrontend: 0.0.0.0:1337 

# Choose from INFO (default), WARN and DEBUG
logLevel: "INFO"

# Actions (buttons) to show up on the WebUI:
actions: 
  # Docs: https://docs.olivetin.app/action-container-control.html 
- title: Restart Plex
  icon: smile
  shell: docker restart plex
  
  # This will send 1 ping 
  # Docs: https://docs.olivetin.app/action-ping.html
- title: Ping Google.com
  shell: ping google.com -c 1
  
  # Restart lightdm on host "overseer"
  # Docs: https://docs.olivetin.app/action-ssh.html
- 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