sharenjun/ARTEX-main

选用指南

AI 根据 README 整理 · 2026/10/16 22:21:49

适用场景

适用于个人学习、学术研究、代码审阅等非攻击性用途，以及本地隔离环境中的技术原理验证。

查看 README 依据

本项目采用 **GNU Affero General Public License v3.0（AGPL-3.0）** 授权，完整条款见仓库根目录的 [LICENSE](LICENSE) 文件。 这意味着任何人都可以自由使用、修改和分发本项目，但**衍生作品必须同样以 AGPL-3.0 开源**；特别地，**若你修改本项目并通过网络（如部署为在线服务）向用户提供，也必须向这些用户公开对应的完整源码**。 > ⚠️ **重要提示**：开源协议本身不限制软件的使用用途。以下的「使用限制」与「免责声明」是作者对使用者的额外约定与郑重声明，请务必遵守。 **ARTEX 仅供个人学习、代码研究与本地技术验证使用，不得用于对任何线上系统或网站发起实际测试。** ### 允许使用范围 - 仅可用于**阅读、学习与研究本项目源码**，以及在**本地隔离环境**中进行技术原理验证； - 适用于个人学习、学术研究、代码审阅等非攻击性用途。 ### 禁止事项 - **严禁使用本工具对任何网站、线上服务或联网系统发起扫描、探测、利用或攻击**（无论是否获得授权、是否为自有资产）； - 严禁将本工具用于任何实际的渗透测试、攻防对抗或生产环境； - 严禁将本工具用于非法入侵、数据窃取、勒索、拒绝服务或任何破坏性、犯罪性活动； - 严禁利用本工具从事违反所在国家/地区法律法规的行为。

目标用户

面向安全研究人员和开发者，用于阅读、学习与研究本项目源码。

查看 README 依据

本项目采用 **GNU Affero General Public License v3.0（AGPL-3.0）** 授权，完整条款见仓库根目录的 [LICENSE](LICENSE) 文件。 这意味着任何人都可以自由使用、修改和分发本项目，但**衍生作品必须同样以 AGPL-3.0 开源**；特别地，**若你修改本项目并通过网络（如部署为在线服务）向用户提供，也必须向这些用户公开对应的完整源码**。 > ⚠️ **重要提示**：开源协议本身不限制软件的使用用途。以下的「使用限制」与「免责声明」是作者对使用者的额外约定与郑重声明，请务必遵守。 **ARTEX 仅供个人学习、代码研究与本地技术验证使用，不得用于对任何线上系统或网站发起实际测试。** ### 允许使用范围 - 仅可用于**阅读、学习与研究本项目源码**，以及在**本地隔离环境**中进行技术原理验证； - 适用于个人学习、学术研究、代码审阅等非攻击性用途。 ### 禁止事项 - **严禁使用本工具对任何网站、线上服务或联网系统发起扫描、探测、利用或攻击**（无论是否获得授权、是否为自有资产）； - 严禁将本工具用于任何实际的渗透测试、攻防对抗或生产环境； - 严禁将本工具用于非法入侵、数据窃取、勒索、拒绝服务或任何破坏性、犯罪性活动； - 严禁利用本工具从事违反所在国家/地区法律法规的行为。

使用方式

可通过 Docker Compose、预编译二进制或源码编译方式部署，启动后访问 http://localhost:8787 使用 Web 界面。

查看 README 依据

脚本会：检测 / 自动安装 Docker → 让你选 **① 全部 Docker** 或 **② 本地编译运行**： - **① 全部 Docker**：填一个 Postgres 密码（可回车随机）→ 自动写 `.env` → `docker compose up -d`。 - **② 本地运行**：选数据库（连已有 / 用 Docker 起一个）→ 生成 `config.json` → `go` 编译内嵌单二进制 → 启动。 装好后打开 **http://localhost:8787**（首次进入 `/setup` 设置管理员密码）。 ### 方式二：Docker Compose（手动） ```bash git clone https://github.com/Autumn-27/ARTEX.git cd ARTEX cp .env.example .env # 填 POSTGRES_PASSWORD、可选 ANTHROPIC_API_KEY docker compose up -d # 拉取 dgddw/artex 镜像 + postgres # → http://localhost:8787 ```

镜像已含常用工具（ripgrep/curl/vim/npm/nmap…）；`./skills` 与 `./data` 以绑定挂载持久化。 远程 MCP 可在系统设置中选择 `http`（Streamable HTTP）或 `sse`（旧版 SSE）。 旧版 SSE 服务通常使用 `GET /sse` 建立事件流，再通过服务返回的 `/message?sessionId=...` 接收 JSON-RPC 请求；配置时将 URL 填为 `/sse`，请求头按 `Authorization=Bearer <token>` 填写。 ### 方式三：下载预编译二进制（Releases） 到 [Releases](https://github.com/Autumn-27/ARTEX/releases) 下载对应平台的 zip，解压后得到 `artex` + `start.sh`（Windows 为 `start.bat`）+ `skills/` + `config.example.json`： ```bash cp config.example.json config.json # 填好 database 连接 ./start.sh # → http://localhost:8787 ```

部署要求

依赖 PostgreSQL 数据库，探索功能需配置 LLM（ANTHROPIC_API_KEY 或 OPENAI_API_KEY）。

查看 README 依据

- 一键导入并按公司资产范围归并，直接进入 ARTEX 的资产图供 agent 探索使用。 - 后台任务持续运行，离开或刷新页面后可从历史记录查看逐类型进度、失败原因和源记录；支持恢复中断任务及仅重试失败记录。 - 拉取记录数与独立资产变更分别统计，逐项提供原始 JSON 下载，避免把部分成功误认为全部完成。 --- ## 安装 > 依赖数据库 **PostgreSQL**；探索需配置 **LLM**（`ANTHROPIC_API_KEY` 或 `OPENAI_API_KEY`，也可在 UI 里配）。 ### 发布产物与平台支持 Docker Hub 镜像默认为 `dgddw/artex`： - 正式版本同时提供版本标签（例如 `vX.Y.Z`）和 `latest`；预发布只推版本标签，不覆盖 `latest`。 - 每个镜像标签都是包含 **Linux AMD64 / ARM64** 的多架构清单，Docker 自动选择宿主机架构；不需要指定 `--platform`。 - `docker-compose.yml` 同样不固定架构。可在 `.env` 用 `ARTEX_IMAGE` 自定义仓库，用 `ARTEX_TAG` 固定版本。 ```bash docker pull dgddw/artex:latest # 查看标签内的架构清单：

已知限制

作者明确声明仅供个人学习、代码研究与本地技术验证使用，不得用于对任何线上系统或网站发起实际测试。

查看 README 依据

本项目采用 **GNU Affero General Public License v3.0（AGPL-3.0）** 授权，完整条款见仓库根目录的 [LICENSE](LICENSE) 文件。 这意味着任何人都可以自由使用、修改和分发本项目，但**衍生作品必须同样以 AGPL-3.0 开源**；特别地，**若你修改本项目并通过网络（如部署为在线服务）向用户提供，也必须向这些用户公开对应的完整源码**。 > ⚠️ **重要提示**：开源协议本身不限制软件的使用用途。以下的「使用限制」与「免责声明」是作者对使用者的额外约定与郑重声明，请务必遵守。 **ARTEX 仅供个人学习、代码研究与本地技术验证使用，不得用于对任何线上系统或网站发起实际测试。** ### 允许使用范围 - 仅可用于**阅读、学习与研究本项目源码**，以及在**本地隔离环境**中进行技术原理验证； - 适用于个人学习、学术研究、代码审阅等非攻击性用途。 ### 禁止事项 - **严禁使用本工具对任何网站、线上服务或联网系统发起扫描、探测、利用或攻击**（无论是否获得授权、是否为自有资产）； - 严禁将本工具用于任何实际的渗透测试、攻防对抗或生产环境； - 严禁将本工具用于非法入侵、数据窃取、勒索、拒绝服务或任何破坏性、犯罪性活动； - 严禁利用本工具从事违反所在国家/地区法律法规的行为。