开源项目oms的安装与配置指南

开源项目oms的安装与配置指南

1. 项目基础介绍

oms是一个基于Go语言开发的运维管理平台。该项目旨在为用户提供一个轻量级、易用且跨平台的应用程序，用以简化运维任务。它的设计思路是模仿xshell并实现ansible或saltstack的部分功能。

2. 项目使用的关键技术和框架

• Go语言：项目的主体语言，用于后端服务的开发。
• Gin：一个高性能的Web框架，用于创建HTTP服务。
• Gorm：一个Go语言下的ORM库，用于数据库交互。
• SSH/SFTP：用于远程登录和文件传输。
• Novnc：实现了基于Web的VNC客户端，允许远程桌面访问。
• WebSocket：用于在用户和服务器之间实现双向通信。

3. 项目安装和配置准备工作

在开始安装之前，请确保您的系统中已经安装了以下工具：

• Git：用于克隆项目代码。
• Go语言环境：Go版本1.17以上，用于编译项目。
• Node.js和Yarn：用于编译前端代码。
• 数据库：项目支持MySQL、PostgreSQL和SQLite数据库，安装其中一个即可。
• Docker（可选）：用于运行项目的Docker容器。

4. 项目安装步骤

克隆项目代码

首先，使用Git克隆项目代码到本地：

git clone --recurse-submodules https://github.com/ssbeatty/oms.git

编译前端代码

进入前端目录并执行以下命令：

cd oms/web/omsUI
yarn
yarn build

编译后端代码

根据您的操作系统，选择相应的命令来编译后端服务：

对于Linux系统：

go build -o oms cmd/omsd/main.go

对于Windows系统：

go build -o oms.exe cmd/omsd/main.go

配置项目

在可执行文件同级目录下创建config.yaml配置文件，参考以下内容进行配置：

app:
  name: oms
  addr: 127.0.0.1
  port: 9090
  mode: dev
  run_start: false

db:
  driver: postgres
  user: root
  password: 123456
  dsn: 127.0.0.1:3306
  db_name: oms

启动服务

使用以下命令启动oms服务：

./oms -c config.yaml

如果希望将oms注册为服务，可以使用以下命令：

对于Windows/Linux：

oms --action install --config config.yaml

对于取消注册服务：

oms --action uninstall

完成以上步骤后，oms服务应该已经成功运行，可通过浏览器访问http://127.0.0.1:9090来使用oms的Web界面。