quick_start

快速开始

1.获取项目

您可以从master分支获取最新版本的代码，在项目根目录中执行

mvn install

也可以直接从https://github.com/fishstormX/logsight/releases 获取最新的稳定版压缩包logsight.tar.gz,它同时包含了启动脚本和配置文件,解压后运行脚本即可使用,例如通过执行：
wget https://github.com/fishstormX/logsight/releases/download/1.1.0-RELEASE/logsight.tar.gz
(gitee镜像：https://gitee.com/fishmaple/logsight/attach_files/433172/download) 下载压缩包，然后执行：
tar -zxvf logsight.tar.gz
即可跳过步骤2

2.数据和配置的准备

Logsight默认使用本地的h2db作为存储介质，您也可选择mysql作为数据库，初始化SQL已经存在于项目中，无需手动进行初始化操作。 配置项目目录下的logsight.yml，您可以修改数据库连接的配置，也可以使用自定义的配置：

logsight:
  port: 8558    #启动的端口，默认为8558端口
#  logdir: ./log    #日志的文件夹位置，默认为
datasource:
  h2:
    url: jdbc:h2:file:/data/logsight/logsight #配置h2数据库的连接地址
    username: sa
    password: sa

将配置文件与项目的启动脚本(/script/logsight)与项目的logsight-admin/target/logsight-admin-xxx.jar一同拷贝至同一目录下, 同时将jar重命名为logsight.jar

3.启动项目

可通过项目目录下的logsight.sh启动和关闭、重启项目，启动用户应拥有相关日志目录的权限

./logsight [options] <stop|start|restart|status>

参数：
-f 为项目指定一个yml配置文件 -e 后台运行logSight，如果不是调试模式 推荐使用此选项 start 启动项目
stop 停止项目
restart 重启项目