OliveTin 使用与安装指南

项目概述

OliveTin 是一个基于 Web 的界面，允许用户安全且简单地执行预定义的 shell 命令。此项目特别适合自托管社区，因其轻量级的设计（低内存占用，几乎不消耗CPU），并且采用 Go 语言编写，搭配现代响应式的单页面应用作为前端，利用 REST/gRPC API 进行通信。

项目目录结构及介绍

OliveTin 的目录结构通常遵循标准的 Go 项目布局，尽管具体的细节可能会因为项目版本更新而有所不同，但可以预期基础结构如下：

.
├── cmd           # 包含主程序入口，如 olivetin-server
├── config        # 配置文件示例或默认配置存放处
│   └── config.yaml # 主配置文件，用于设置服务端参数和命令映射
├── internal      # 内部业务逻辑和组件，不对外暴露
│   ├── ...
├── pkg           # 各种功能性包，封装项目核心功能
│   ├── ...
├── docs          # 文档和说明文件
├── webui         # 前端资源，构建而成的现代响应式SPA应用
│   ├── static    # 静态资源文件（CSS, JS）
│   ├── templates # 视觉模板文件
├── LICENSE       # 许可证文件，遵循 AGPL-3.0
└── README.md     # 项目简介和快速入门指南

项目启动文件介绍

启动文件主要位于 cmd 目录下，例如 cmd/olivetin-server/main.go。这是应用程序的主要入口点。通过此文件，你可以执行启动脚本，以启动服务器并监听指定端口，处理来自Web界面的请求。常规步骤包括初始化环境变量，读取配置，设置API和HTTP服务器等。

项目配置文件介绍

config.yaml 是 OliveTin 的核心配置文件，它定义了如何运行服务以及哪些shell命令可通过Web UI访问。文件的大致结构和部分可能包含的内容如下：

actions:
  # 示例：重启Plex容器
  - title: Restart Plex
    icon: restart
    shell: docker restart plex
  
  # 动态参数示例：ping主机
  - title: Ping host
    icon: ping
    shell: ping [[ host ]]
      -c [[ count ]]
    arguments:
      - name: host
        title: host
        type: ascii_identifier
        default: example.com
      - name: count
        title: Count
        type: int
        default: 1

这个配置允许用户自定义在Web界面上显示的动作按钮，每个动作都绑定了特定的shell命令和可选参数。确保正确配置此文件是成功部署和使用OliveTin的关键。

---

以上便是OliveTin的基本结构概览、启动文件和配置文件的简要介绍。在实际操作中，请参考项目最新的README和文档，因为具体实现细节可能会有所更改。为了正确设置和运用OliveTin，仔细阅读其官方文档和遵循贡献指南是非常重要的。