W5 SOAR 文档

Appearance

Return to top
On this page

注意：

  • 请最好使用 Git 拉取代码，方便后续版本更新
  • docker 目录是数据存放目录，请注意备份保存
  • Linux、Mac 已经测试可用，Win 自行测试(需要修改目录路径)

本文档拿 Centos 8 做演示

安装Docker

1.更新 Docker 源地址

shell
curl https://download.docker.com/linux/centos/docker-ce.repo -o /etc/yum.repos.d/docker-ce.repo

2.安装 Docker

shell
# --allowerasing 解决和 Podman 的冲突，一般无需执行，如果遇到 Podman 等错误再执行
yum install --allowerasing docker-ce -y

3.启动 Docker

shell
service docker start

4.安装 docker-compose

shell
# 国内源，适用国内服务器
curl -L https://get.daocloud.io/docker/compose/releases/download/v2.15.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose && chmod +x /usr/local/bin/docker-compose

# 国外源，适用国外服务器，如果不生效请用上面的源
curl -L https://github.com/docker/compose/releases/download/2.15.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose && chmod +x /usr/local/bin/docker-compose

部署启动

1.拉取代码

shell
# 利用 Git 拉取代码方便后续更新
git clone https://github.com/w5teams/w5.git && cd w5

2.第一次启动

第一次启动需要初始化数据库，所以需等待 10-20 秒，才能访问成功。 访问地址：http://ip:8888/ 账号：admin 密码：12345678

shell
# 此命令，即可利用 docker 启动 W5
cp -r apps docker && cp config.ini docker && docker-compose up -d
  • cp -r apps docker 复制 apps 目录到 docker 目录下，实现目录映射
  • cp config.ini docker 复制 config.ini 目录到 docker 目录下，实现目录映射
  • docker-compose up -d 后台启动项目，去掉 -d 前台启动，方便调试

3.平常启动

shell
# 除了第一次启动外，请使用此命令，如果用上条命令会覆盖 apps 目录，会造成数据丢失
docker-compose up -d

4.版本更新

shell
# 每次 w5 更新版本后，执行此命令即可更新到最新版本
git pull && docker-compose build && docker-compose up -d
  • git pull 利用 Git 拉取最新代码
  • docker-compose build 重新编译最新代码
  • docker-compose up -d 后台启动项目，去掉 -d 前台启动，方便调试

Docker 目录说明

为了保证 Docker 重新构建后数据不会丢失，所有的核心数据全部存放在 docker 目录下。 使用 git pull 不会造成 docker 目录丢失数据，但是手动更新覆盖请备份好 docker 目录，防止丢失数据。 部署迁移，请提前备份好 docker 目录，到时覆盖此目录即可。

目录结构：

shell
- apps # w5 apps 目录映射，页面上传或手动上传均放在此目录下
- conf.d # mysql 配置文件目录映射，修改此文件可以配置 Mysql 的参数，一般无需修改
- logs # w5 日志存放目录，可在此次查看执行日志
- mysql_db # mysql db 目录映射，数据库文件存放在此，方便后期迁移
- redis_db # redis db 目录映射，数据库文件存放在此，方便后期迁移
- sql # w5 sql 目录映射，第一次启动需要此文件初始化 Mysql
- config.ini # w5 配置文件映射，修改此文件可以配置 W5 的参数，一般无需修改
- supervisord.conf # supervisord 配置文件，一般无需修改