OliveTin

<img alt="项目标志" src="https://github.com/OliveTin/OliveTin/blob/main/webui.dev/OliveTinLogo.png" align="right" width="160px" />

OliveTin 提供一个网页界面，让用户可以安全且简单地访问预定义的 shell 命令。

<img alt="截图" src="https://github.com/OliveTin/OliveTin/blob/main/var/marketing/screenshotDesktop.png" /> <a href="#screenshots">下方有更多截图</a>

使用场景

为技术水平较低的人安全地提供命令访问权限：

• 例如：为你的家人提供一个按钮来执行 podman restart plex
• 例如：为初级管理员提供一个带下拉菜单的简单网页表单，以启动你的自定义脚本。backupScript.sh --folder {{ customerName }}
• 例如：在接下来的20分钟内启用对服务器的 SSH 访问 firewall-cmd --add-service ssh --timeout 20m

简化复杂命令，使其易于访问和重复使用：

• 例如：在家中墙壁上安装的平板电脑上展示复杂命令。wake-on-lan aa:bb:cc:11:22:33
• 例如：从手机上在服务器上运行长时间运行的命令。dnf update -y
• 例如：定义带有大量预设参数的复杂命令，并将一些参数转换为下拉选择框。docker rm {{ container }} && docker create {{ container }} && docker start {{ container }}

加入 Discord 社区与其他用户讨论使用场景，或寻求入门支持。

YouTube 演示视频

特性

• 响应式、触控友好的用户界面 - 非常适合平板电脑和移动设备
• 超简单的YAML配置 - 因为如今不用YAML就不算"云原生"了 :-)
• 深色模式 - 适合喜欢这种风格的用户
• 无障碍访问 - 通过Firefox的所有无障碍检查，并严肃对待无障碍问题
• 容器化 - 可快速测试和运行，非常适合自托管社区
• 与任何系统集成 - OliveTin只运行Linux shell命令，因此理论上你可以通过使用curl、ping等命令与许多系统集成。不过，编写自己的shell脚本是扩展OliveTin的好方法
• 资源占用轻量 - 只使用几MB的内存，几乎不占用CPU。使用Go语言编写，web界面采用现代、响应式的单页应用程序，使用REST/gRPC API
• 大量单元测试和风格检查 - 帮助潜在贡献者保持一致性，并提高可维护性

截图

桌面网页浏览器：

<p align = "center"> <img alt = "截图" src = "https://github.com/OliveTin/OliveTin/blob/main/var/marketing/screenshotDesktop.png" /> </p>

桌面网页浏览器（深色模式）：

<p align = "center"> <img alt = "截图" src = "https://github.com/OliveTin/OliveTin/blob/main/var/marketing/screenshotDesktopDark.png" /> </p>

移动设备屏幕大小（响应式布局）：

<p align = "center"> <img alt = "截图" src = "https://github.com/OliveTin/OliveTin/blob/main/var/marketing/screenshotMobile.png" style = "height: 700px;" /> </p>

文档

所有文档都可以在 http://docs.olivetin.app 找到。包括安装和使用指南等。

config.yaml 快速参考

这是 config.yaml 的一个简单示例 - 再次强调，有关如何编写 config.yaml 的大量文档可以在文档网站上找到。

• （推荐）Linux包安装（.rpm/.deb）安装说明
• 容器（podman/docker）安装说明
• Docker compose安装说明
• Helm on Kubernetes安装说明
• Kubernetes（手动）安装说明
• .tar.gz（手动）安装说明

如果你正在运行标准服务，请将此 config.yaml 放在 /etc/OliveTin/ 中，如果在容器中运行，则将其挂载到 /config。

# 在所有可用地址上监听1337端口
listenAddressSingleHTTPFrontend: 0.0.0.0:1337

# 从INFO（默认）、WARN和DEBUG中选择
logLevel: "INFO"

# 在WebUI上显示的操作（按钮）：
actions:
  # 文档：https://docs.olivetin.app/action-container-control.html
- title: 重启Plex
  icon: restart
  shell: docker restart plex

  # 这将发送1个ping
  # 文档：https://docs.olivetin.app/action-ping.html
- title: Ping主机
  shell: ping {{ host }} -c {{ count }}
  icon: ping
  arguments:
    - name: host
      title: 主机
      type: ascii_identifier
      default: example.com

• name: count title: 计数 type: int default: 1

在主机"webserver1"上重启http服务

文档：https://docs.olivetin.app/action-ssh.html

• title: 重启httpd icon: restart shell: ssh root@webserver1 'service httpd restart'

完整的配置示例可以在本仓库的[config.yaml](https://github.com/OliveTin/OliveTin/blob/main/config.yaml)文件中找到。