Files
3proxyUI/README.md

54 lines
949 B
Markdown

# 3proxy UI
Control panel and runtime bundle for 3proxy in Docker.
## Current focus
The project now includes both the UI and the first backend/runtime slice:
- Express-based control plane API
- generated `3proxy.cfg` from persisted panel state
- runtime manager for start/restart/reload
- Docker image that builds the panel and compiles 3proxy in-container
- panel views for dashboard, users, and system
- edge-case-focused frontend and backend tests
## Local run
```bash
npm install
npm run dev
npm run dev:server
```
Default panel credentials:
- login: `admin`
- password: `proxy-ui-demo`
## Docker run
```bash
docker compose up --build
```
Published ports:
- panel: `3000`
- socks main: `1080`
- socks lab: `2080`
- http proxy: `3128`
- 3proxy admin: `8081`
Runtime state is persisted in the Docker volume `3proxyui_3proxy-runtime`.
## Scripts
```bash
npm run dev
npm run dev:server
npm run build
npm run test
npm run test:run
```