BaaRai/ARTEX

选用指南

AI 根据 README 整理 · 2026/11/2 03:21:44

使用方式

可通过 Web 界面（默认端口 8787）使用，支持 Docker、预编译二进制或源码构建等多种安装方式。

查看 README 依据

The script will: detect / auto-install Docker → then let you choose **① all-Docker** or **② local build and run**: - **① All-Docker**: enter a Postgres password (press Enter for a random one) → auto-writes `.env` → `docker compose up -d`. - **② Local run**: choose a database (connect to an existing one / start one with Docker) → generates `config.json` → `go` builds the embedded single binary → starts. Once installed, open **http://localhost:8787** (on first entry, `/setup` sets the admin password). ### Option 2: Docker Compose (manual) ```bash

`/message?sessionId=...` returned by the server; when configuring, set the URL to `/sse` and the request header as `Authorization=Bearer <token>`. ### Option 3: download prebuilt binaries (Releases) Download the zip for your platform from [Releases](https://github.com/BaaRai/ARTEX/releases); after extracting you get `artex` + `start.sh` (`start.bat` on Windows) + `skills/` + `config.example.json`: ```bash cp config.example.json config.json # fill in the database connection ./start.sh # → http://localhost:8787 ```

> Please start with `start.sh` / `start.bat` instead of running `./artex` directly. It is a daemon script: if the process crashes, it restarts it after a backoff. > To keep it running in the background: `nohup ./start.sh >artex.log 2>&1 &`. ### Option 4: build the single binary from source ```bash # 1) frontend static export cd web && npm ci && npm run build:static && cd .. # 2) copy into the embed directory cp -r web/out server/webui/dist # 3) build (only -tags embedui embeds the frontend) CGO_ENABLED=0 go build -tags embedui -o artex ./cmd/artex ./start.sh ```

部署要求

需要 PostgreSQL 数据库和 LLM 服务（提供 ANTHROPIC_API_KEY 或 OPENAI_API_KEY，也可在 UI 中配置，支持本地 Ollama）。

查看 README 依据

- Choose the targets and asset types to sync by **project** or **task** (domains / subdomains / IPs / ports / sites / endpoints…); - One-click import, merged by company asset scope, straight into ARTEX's asset graph for agents to explore. --- ## Installation > Requires a **PostgreSQL** database; exploration requires an **LLM** (`ANTHROPIC_API_KEY` or `OPENAI_API_KEY`, which can also be configured in the UI). ### Option 1: one-click install script (recommended) ```bash git clone https://github.com/BaaRai/ARTEX.git cd ARTEX ./install.sh ```

**LLM**: `export ANTHROPIC_API_KEY=sk-...` (or `OPENAI_API_KEY`); you can also fill it in on the UI's "LLM Configuration" page — which can add a local Ollama server as a keyless provider (format "Ollama", base URL default `http://127.0.0.1:11434/v1`, models loaded from the server). Optional: `ARTEX_LLM_PROVIDER` (anthropic | openai | openai-responses | ollama) / `ARTEX_LLM_MODEL` / `ARTEX_LLM_BASE_URL` / `ARTEX_LLM_PROXY`. **Concurrency**: the number of work agents per task is configured in "System Settings" (default 3).

已知限制

演示模式仅生成明确标记的模拟记录，不会请求真实目标；二进制可能因 UPX 压缩与某些内核或安全策略不兼容，默认禁用；升级不涉及数据迁移，但建议备份。

查看 README 依据

UPX self-extracting binaries may be incompatible with some Linux kernels, virtualization environments, or security policies, so they are disabled by default. Use `ARTEX_TARGETS` to customize the targets; when you have confirmed the target runtime is compatible, explicitly pass `--upx` to further shrink the binary: ```bash ARTEX_TARGETS=linux/amd64,windows/amd64 ./build.sh --release ./build.sh --target linux/amd64 --upx ``` --- ## Backups `scripts/backup.sh` dumps the Postgres database (and optionally the data directory) with timestamped output and rotation: ```bash

In this version, history is viewed via vulnerability details and sessions; it is not yet included in vulnerability report exports or task archive packages, and is not automatically linked to traffic captures. Demo mode only generates clearly labeled simulated records and never requests real targets. ### Running and testing locally ```bash ./dev.sh # backend(:8787) + traffic proxy(:8788) + frontend next dev(:5173) → http://localhost:5173 ``` - Backend: `go run ./cmd/artex` (without `-tags embedui`, the frontend is not embedded)