@chenpu17/tcpmapping 2.0.0 → 2.1.0

package/README.md

@@ -1,103 +1,185 @@
-# TCP转发服务器
+# TcpMapping
 
-一个功能强大、安全可靠的TCP端口转发服务器，支持多端口映射、WebUI管理界面和实时连接监控。
+TCP port forwarding server with WebUI management and real-time connection monitoring.
 
-## 功能特性
+TCP端口转发服务器，支持WebUI管理界面和实时连接监控。
 
-### 核心功能
-- **TCP协议端口转发** - 将TCP请求转发到后端服务器
-- **多端口映射配置** - 同时支持多个端口转发规则
-- **动态配置管理** - 通过WebUI实时添加/删除/启动/停止端口映射
-- **连接监控** - 实时显示每个映射的连接数和流量统计
+---
 
-### WebUI管理界面
-- 现代化响应式Web界面
-- 实时系统状态监控（映射数、连接数、运行时间）
-- 每个端口映射的连接数和流量统计
-- 映射的启动/停止控制
+## Features | 功能特性
 
-### 安全特性
-- 强密码策略（8字符+大小写+数字）
-- 登录失败保护（5次失败锁定30分钟）
-- 会话管理（24小时自动超时）
-- bcrypt 12轮密码哈希加密
-- 自动生成的Session Secret
+- **TCP Port Forwarding** - Forward TCP traffic to backend servers | TCP端口转发
+- **Multiple Mappings** - Manage multiple forwarding rules simultaneously | 多端口映射
+- **WebUI Management** - Modern web interface for real-time monitoring | WebUI管理界面
+- **Connection Monitoring** - Real-time connection count and traffic statistics | 实时连接监控
+- **Secure Authentication** - bcrypt password hashing, login protection | 安全认证
 
-## 快速开始
+---
+
+## Installation | 安装
+
+### NPM Global Install (Recommended) | NPM全局安装（推荐）
 
-### 安装
 ```bash
-# 安装依赖
-npm install
+npm install -g @chenpu17/tcpmapping
 
-# 设置管理员密码
-npm run setup-password
+tcpmapping setup-password   # Set admin password | 设置管理员密码
+tcpmapping init             # Create config file | 创建配置文件
+tcpmapping start            # Start server | 启动服务
+```
+
+### Local Install | 本地安装
 
-# 启动服务器
+```bash
+git clone https://github.com/chenpu17/TcpMapping.git
+cd TcpMapping
+npm install
+npm run setup-password
 npm start
 ```
 
-### 访问
-启动后访问 **http://localhost:9999** 进入管理界面。
+---
+
+## CLI Commands | CLI命令
+
+| Command | Description |
+|---------|-------------|
+| `tcpmapping start` | Start server in background | 后台启动服务 |
+| `tcpmapping stop` | Stop server | 停止服务 |
+| `tcpmapping restart` | Restart server | 重启服务 |
+| `tcpmapping status` | Show status and config paths | 查看状态和配置路径 |
+| `tcpmapping logs` | Show recent logs | 查看最近日志 |
+| `tcpmapping logs -f` | Follow logs in real-time | 实时跟踪日志 |
+| `tcpmapping setup-password` | Set admin password | 设置管理员密码 |
+| `tcpmapping init` | Create config file | 创建配置文件 |
+
+---
 
-## 配置说明
+## WebUI
 
-编辑 `config.json` 配置端口映射：
+After starting, visit **http://localhost:9999**
+
+启动后访问 **http://localhost:9999**
+
+Default username | 默认用户名: `admin`
+
+---
+
+## Configuration | 配置
+
+Config file location (priority order) | 配置文件位置（优先级）:
+1. `./config.json` - Current directory | 当前目录
+2. `~/.tcpmapping/config.json` - User data directory | 用户数据目录
+
+### Example | 示例
 
 ```json
 {
   "mappings": [
     {
-      "name": "服务名称",
+      "name": "web-server",
       "listen": { "host": "0.0.0.0", "port": 8080 },
       "target": { "host": "192.168.1.100", "port": 3000 }
+    },
+    {
+      "name": "database",
+      "listen": { "host": "127.0.0.1", "port": 3307 },
+      "target": { "host": "db.example.com", "port": 3306 }
     }
   ],
-  "webui": { "enabled": true, "port": 9999, "host": "0.0.0.0" },
-  "logging": { "enabled": true, "level": "info" }
+  "webui": { "port": 9999 },
+  "logging": { "level": "info" }
 }
 ```
 
-## 项目结构
+### Config Options | 配置项
+
+| Option | Description |
+|--------|-------------|
+| `mappings[].name` | Mapping name | 映射名称 |
+| `mappings[].listen.host` | Listen address (0.0.0.0 for all) | 监听地址 |
+| `mappings[].listen.port` | Listen port | 监听端口 |
+| `mappings[].target.host` | Target host IP or domain | 目标主机 |
+| `mappings[].target.port` | Target port | 目标端口 |
+| `webui.port` | WebUI port (default: 9999) | WebUI端口 |
+| `logging.level` | Log level: debug/info/warn/error | 日志级别 |
+
+---
+
+## Data Persistence | 数据持久化
+
+User configuration is stored in `~/.tcpmapping/`:
+
+用户配置存储在 `~/.tcpmapping/` 目录：
 
+- `config.json` - Port mapping configuration | 端口映射配置
+- `auth-config.json` - Authentication configuration | 认证配置
+- `tcpmapping.log` - Log file | 日志文件
+- `tcpmapping.pid` - PID file | PID文件
+
+**Upgrading will NOT overwrite your configuration.**
+
+**升级不会覆盖你的配置文件。**
+
+---
+
+## Security | 安全特性
+
+- **Strong Password Policy** - 8+ chars, uppercase, lowercase, numbers | 强密码策略
+- **Login Protection** - Lock after 5 failed attempts for 30 minutes | 登录保护
+- **Session Timeout** - 24 hours auto expiration | 会话超时
+- **Password Encryption** - bcrypt with 12 rounds | bcrypt加密
+
+---
+
+## API
+
+See [docs/API.md](docs/API.md) for API documentation.
+
+详细API文档请参阅 [docs/API.md](docs/API.md)
+
+### Quick Reference | 快速参考
+
+```bash
+# Health check (no auth) | 健康检查
+curl http://localhost:9999/api/health
+
+# Login | 登录
+curl -X POST http://localhost:9999/api/login \
+  -H "Content-Type: application/json" \
+  -d '{"username":"admin","password":"YourPassword"}' \
+  -c cookies.txt
+
+# Get mappings | 获取映射列表
+curl http://localhost:9999/api/mappings -b cookies.txt
 ```
-├── server.js           # 主服务器
-├── config.json         # 端口映射配置
-├── auth-config.json    # 认证配置（敏感）
-├── setup-password.js   # 密码设置工具
-├── package.json        # 项目配置
-├── .gitignore          # Git忽略规则
-├── public/             # Web界面
-│   ├── login.html      # 登录页面
-│   └── dashboard.html  # 管理面板
-└── docs/               # 文档目录
-    ├── API.md          # API接口文档
-    ├── 功能总结.md      # 功能清单
-    └── 安全配置说明.md  # 安全指南
+
+---
+
+## FAQ | 常见问题
+
+### Forgot password? | 忘记密码？
+
+```bash
+tcpmapping setup-password
+# or | 或
+npm run reset-password
 ```
 
-## API接口
+### Check if running? | 检查运行状态？
 
-详细API文档请参阅 [docs/API.md](docs/API.md)
+```bash
+tcpmapping status
+```
+
+### Port already in use? | 端口被占用？
 
-主要接口：
-- `GET /api/health` - 健康检查（无需认证）
-- `POST /api/login` - 登录
-- `GET /api/mappings` - 获取映射列表（含连接数统计）
-- `POST /api/mappings` - 添加映射
-- `PUT /api/mappings/:id` - 更新映射
-- `DELETE /api/mappings/:id` - 删除映射
-- `POST /api/mappings/:id/start` - 启动映射
-- `POST /api/mappings/:id/stop` - 停止映射
-- `GET /api/connections` - 获取连接状态
-- `GET /api/status` - 获取系统状态
+Edit `webui.port` or `mappings[].listen.port` in config.json.
 
-## 技术栈
+修改 config.json 中的 `webui.port` 或 `mappings[].listen.port`。
 
-- **后端**: Node.js, Express.js, bcryptjs
-- **前端**: 原生HTML/CSS/JavaScript
-- **安全**: bcrypt密码哈希, Session管理
+---
 
-## 许可证
+## License | 许可证
 
-MIT License 
+MIT License

package/bin/tcpmapping.js

@@ -6,8 +6,9 @@ const fs = require('fs');
 const os = require('os');
 
 const APP_NAME = 'tcpmapping';
-const PID_FILE = path.join(os.tmpdir(), 'tcpmapping.pid');
-const LOG_FILE = path.join(os.tmpdir(), 'tcpmapping.log');
+const DATA_DIR = path.join(os.homedir(), '.tcpmapping');
+const PID_FILE = path.join(DATA_DIR, 'tcpmapping.pid');
+const LOG_FILE = path.join(DATA_DIR, 'tcpmapping.log');
 const SERVER_FILE = path.join(__dirname, '..', 'server.js');
 const SETUP_PASSWORD_FILE = path.join(__dirname, '..', 'setup-password.js');
 
@@ -21,11 +22,52 @@ const colors = {
   red: (text) => `\x1b[31m${text}\x1b[0m`,
   yellow: (text) => `\x1b[33m${text}\x1b[0m`,
   blue: (text) => `\x1b[34m${text}\x1b[0m`,
-  cyan: (text) => `\x1b[36m${text}\x1b[0m`
+  cyan: (text) => `\x1b[36m${text}\x1b[0m`,
+  gray: (text) => `\x1b[90m${text}\x1b[0m`
 };
 
+// 确保数据目录存在
+function ensureDataDir() {
+  if (!fs.existsSync(DATA_DIR)) {
+    fs.mkdirSync(DATA_DIR, { recursive: true });
+  }
+}
+
+// 获取配置文件路径（按优先级）
+function getConfigPath() {
+  // 优先级1: 当前工作目录
+  const cwdPath = path.join(process.cwd(), 'config.json');
+  if (fs.existsSync(cwdPath)) {
+    return cwdPath;
+  }
+
+  // 优先级2: 用户数据目录
+  const dataPath = path.join(DATA_DIR, 'config.json');
+  if (fs.existsSync(dataPath)) {
+    return dataPath;
+  }
+
+  return null;
+}
+
+// 获取认证配置文件路径
+function getAuthConfigPath() {
+  const cwdPath = path.join(process.cwd(), 'auth-config.json');
+  if (fs.existsSync(cwdPath)) {
+    return cwdPath;
+  }
+
+  const dataPath = path.join(DATA_DIR, 'auth-config.json');
+  if (fs.existsSync(dataPath)) {
+    return dataPath;
+  }
+
+  return null;
+}
+
 // 检查进程是否运行
 function isRunning() {
+  ensureDataDir();
   if (!fs.existsSync(PID_FILE)) {
     return false;
   }
@@ -50,6 +92,17 @@ function start() {
     return;
   }
 
+  // 检查是否已初始化
+  const configPath = getConfigPath();
+  const authPath = getAuthConfigPath();
+
+  if (!authPath) {
+    console.log(colors.yellow('未设置管理员密码，请先运行:'));
+    console.log(colors.cyan('  tcpmapping setup-password'));
+    return;
+  }
+
+  ensureDataDir();
   console.log(colors.blue(`Starting ${APP_NAME}...`));
 
   const out = fs.openSync(LOG_FILE, 'a');
@@ -58,7 +111,7 @@ function start() {
   const child = spawn('node', [SERVER_FILE], {
     detached: true,
     stdio: ['ignore', out, err],
-    cwd: path.dirname(SERVER_FILE)
+    cwd: process.cwd() // 使用当前目录，以便server可以找到当前目录的config
   });
 
   fs.writeFileSync(PID_FILE, child.pid.toString());
@@ -66,7 +119,10 @@ function start() {
 
   console.log(colors.green(`${APP_NAME} started successfully (PID: ${child.pid})`));
   console.log(colors.cyan(`WebUI: http://localhost:9999`));
-  console.log(colors.cyan(`Log file: ${LOG_FILE}`));
+  console.log(colors.gray(`Log file: ${LOG_FILE}`));
+  if (configPath) {
+    console.log(colors.gray(`Config: ${configPath}`));
+  }
 }
 
 // 停止服务
@@ -126,8 +182,14 @@ function restart() {
 // 查看状态
 function status() {
   const pid = isRunning();
+  const configPath = getConfigPath();
+  const authPath = getAuthConfigPath();
+
+  console.log(colors.cyan('=== TcpMapping Status ===\n'));
+
+  // 服务状态
   if (pid) {
-    console.log(colors.green(`${APP_NAME} is running (PID: ${pid})`));
+    console.log(colors.green(`Service: Running (PID: ${pid})`));
 
     // 尝试获取健康状态
     try {
@@ -138,23 +200,36 @@ function status() {
         res.on('end', () => {
           try {
             const health = JSON.parse(data);
-            console.log(colors.cyan(`  Status: ${health.status}`));
-            console.log(colors.cyan(`  Uptime: ${Math.floor(health.uptime / 60)} minutes`));
-            console.log(colors.cyan(`  Active Mappings: ${health.activeMappings}`));
-            console.log(colors.cyan(`  Active Connections: ${health.activeConnections}`));
+            console.log(`  Uptime: ${Math.floor(health.uptime / 60)} minutes`);
+            console.log(`  Active Mappings: ${health.activeMappings}`);
+            console.log(`  Active Connections: ${health.activeConnections}`);
           } catch (e) {}
+          showPaths();
         });
       });
-      req.on('error', () => {});
-      req.on('timeout', () => req.destroy());
-    } catch (e) {}
+      req.on('error', () => showPaths());
+      req.on('timeout', () => { req.destroy(); showPaths(); });
+    } catch (e) {
+      showPaths();
+    }
   } else {
-    console.log(colors.red(`${APP_NAME} is not running`));
+    console.log(colors.red('Service: Stopped'));
+    showPaths();
+  }
+
+  function showPaths() {
+    console.log('');
+    console.log(colors.cyan('=== Configuration ===\n'));
+    console.log(`Data Dir: ${DATA_DIR}`);
+    console.log(`Config: ${configPath || colors.yellow('Not found (run: tcpmapping init)')}`);
+    console.log(`Auth: ${authPath || colors.yellow('Not found (run: tcpmapping setup-password)')}`);
+    console.log(`Log: ${LOG_FILE}`);
   }
 }
 
 // 查看日志
 function logs(follow = false) {
+  ensureDataDir();
   if (!fs.existsSync(LOG_FILE)) {
     console.log(colors.yellow('No log file found'));
     return;
@@ -176,10 +251,15 @@ function logs(follow = false) {
 
 // 设置密码
 function setupPassword() {
+  ensureDataDir();
   console.log(colors.blue('Setting up password...'));
+  console.log(colors.gray(`Config will be saved to: ${DATA_DIR}`));
+  console.log('');
+
   const child = spawn('node', [SETUP_PASSWORD_FILE], {
     stdio: 'inherit',
-    cwd: path.dirname(SETUP_PASSWORD_FILE)
+    cwd: DATA_DIR, // 在数据目录运行，使auth-config.json保存到数据目录
+    env: { ...process.env, TCPMAPPING_DATA_DIR: DATA_DIR }
   });
 
   child.on('exit', (code) => {
@@ -189,29 +269,41 @@ function setupPassword() {
 
 // 初始化配置
 function init() {
-  const configDir = process.cwd();
-  const configFile = path.join(configDir, 'config.json');
+  ensureDataDir();
+
+  // 检查当前目录和数据目录是否已有配置
+  const cwdConfig = path.join(process.cwd(), 'config.json');
+  const dataConfig = path.join(DATA_DIR, 'config.json');
+
+  if (fs.existsSync(cwdConfig)) {
+    console.log(colors.yellow(`config.json already exists in current directory`));
+    console.log(colors.gray(`  ${cwdConfig}`));
+    return;
+  }
 
-  if (fs.existsSync(configFile)) {
-    console.log(colors.yellow('config.json already exists'));
+  if (fs.existsSync(dataConfig)) {
+    console.log(colors.yellow(`config.json already exists in data directory`));
+    console.log(colors.gray(`  ${dataConfig}`));
+    console.log('');
+    console.log('To create a local config, copy it to current directory:');
+    console.log(colors.cyan(`  cp ${dataConfig} ./config.json`));
     return;
   }
 
   const defaultConfig = {
-    mappings: [
-      {
-        name: "Example",
-        listen: { host: "0.0.0.0", port: 8080 },
-        target: { host: "127.0.0.1", port: 3000 }
-      }
-    ],
-    webui: { enabled: true, port: 9999, host: "0.0.0.0" },
-    logging: { enabled: true, level: "info" }
+    mappings: [],
+    webui: { port: 9999 },
+    logging: { level: "info" }
   };
 
-  fs.writeFileSync(configFile, JSON.stringify(defaultConfig, null, 2));
+  // 保存到数据目录
+  fs.writeFileSync(dataConfig, JSON.stringify(defaultConfig, null, 2));
   console.log(colors.green('Created config.json'));
-  console.log(colors.cyan('Edit config.json to configure your port mappings'));
+  console.log(colors.gray(`  ${dataConfig}`));
+  console.log('');
+  console.log('Edit the config file to add your port mappings.');
+  console.log('Or copy it to current directory for project-specific config:');
+  console.log(colors.cyan(`  cp ${dataConfig} ./config.json`));
 }
 
 // 显示版本
@@ -232,7 +324,7 @@ ${colors.yellow('Commands:')}
   ${colors.green('start')}           Start the server in background
   ${colors.green('stop')}            Stop the server
   ${colors.green('restart')}         Restart the server
-  ${colors.green('status')}          Show server status
+  ${colors.green('status')}          Show server status and config paths
   ${colors.green('logs')}            Show recent logs
   ${colors.green('logs -f')}         Follow logs in real-time
   ${colors.green('setup-password')}  Set up admin password
@@ -240,10 +332,15 @@ ${colors.yellow('Commands:')}
   ${colors.green('version')}         Show version
   ${colors.green('help')}            Show this help message
 
+${colors.yellow('Config Paths (priority order):')}
+  1. ./config.json       (current directory - project config)
+  2. ~/.tcpmapping/      (user data directory - global config)
+
 ${colors.yellow('Examples:')}
-  tcpmapping start          # Start server
-  tcpmapping status         # Check if server is running
-  tcpmapping logs -f        # Follow logs
+  tcpmapping init             # Create config file
+  tcpmapping setup-password   # Set admin password
+  tcpmapping start            # Start server
+  tcpmapping status           # Check status and config paths
 
 ${colors.yellow('WebUI:')}
   After starting, visit http://localhost:9999

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chenpu17/tcpmapping",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "TCP端口转发服务器，支持多端口映射、WebUI管理界面和实时连接监控",
   "main": "server.js",
   "bin": {
@@ -16,8 +16,7 @@
     "bin/",
     "public/",
     "server.js",
-    "setup-password.js",
-    "config.json"
+    "setup-password.js"
   ],
   "keywords": [
     "tcp",