fdb2 1.0.37 → 1.0.39

package/README.md

@@ -78,6 +78,53 @@ http://localhost:9800
 
 > 💡 **Tip**: Default port is 9800, but if occupied, it will automatically select another available port
 
+## 🌍 Remote Database Access (HTTP Proxy)
+
+Sometimes the database is **not reachable from your machine** — it sits behind a corporate VPN, on a private subnet, or on a bastion host. In that case, run `fdb2` on a machine that *can* reach it and let your local client talk to that service over HTTP.
+
+### How it works
+Add a connection of type **Remote Proxy Service** and point it at the remote `fdb2` server. Once saved, **every database connection configured on that remote server is merged into your local connection list**, and every operation — browsing schemas, running SQL, DDL, data CRUD, export, even editing or deleting the connection config — is forwarded to the remote server and executed there.
+
+The remote database password never leaves the remote server: it is **not** sent down to your client.
+
+### Setup
+1. **On the machine that can reach the database**, start the service and confirm it is reachable from your client:
+   ```bash
+   fdb2 start -p 9800
+   # then open http://<remote-ip>:9800 in a browser to confirm
+   ```
+2. **On that remote service**, add the real database connections as usual.
+3. **On your local client** (web UI or the VSCode extension) → *Add Connection* → **Type: Remote Proxy Service**:
+
+   | Field | Description |
+   | --- | --- |
+   | Service URL | Base URL of the remote `fdb2` server, e.g. `http://10.0.0.5:9800` — the **root** of the service, without a trailing `/api`. |
+   | Access Token | Optional. Only needed when the remote server was started with `DB_TOOL_REMOTE_TOKEN`. |
+
+4. **Save.** The remote connections now appear in your local connection list — expand, query, and edit them exactly like local ones. Editing or deleting one of those remote connections applies to the remote server's configuration.
+
+### Securing the remote service
+```bash
+# on the remote machine
+DB_TOOL_REMOTE_TOKEN=your-secret fdb2 start -p 9800
+
+# 也可以把令牌持久化保存，之后 `fdb2 start` 会自动读取，无需每次设置环境变量：
+fdb2 token set your-secret
+fdb2 start -p 9800
+# 查看已保存的令牌：
+fdb2 token get
+```
+Once set, the remote server rejects every HTTP request that does not carry the matching `x-db-tool-token` header, and answers `远程访问令牌无效` (*invalid remote access token*). Put the same value into the proxy connection's **Access Token** field.
+
+> ⚠️ Set the token **only on the remote server**. Setting it on your own local server would also lock out your local browser/extension.
+> The token guards the HTTP entry point only; in-process calls (e.g. from the VSCode extension host) are not affected.
+
+### Notes & limits
+- The remote service must be reachable from your client (LAN IP, VPN, SSH tunnel, …).
+- Proxying is **one level deep** — a chain `A → B → C` is not supported.
+- If the remote service is unreachable, the proxy entry exposes no connections and the connection detail panel shows the error.
+- The remote server keeps its own database credentials; the local client only stores the proxy URL and token.
+
 ## 🔌 VSCode Extension
 
 Prefer staying inside the editor? `fdb2` also ships as a **VSCode extension** — "Database Tool (fdb2)" — that embeds the same UI directly in VSCode.

package/bin/fdb2.js

@@ -50,6 +50,31 @@ function deleteServerInfo() {
   }
 }
 
+// 获取本地配置文件路径（与 PID/INFO 同目录）
+function getConfigPath() {
+  const dataDir = process.env.DB_TOOL_DATA_DIR || path.join(os.homedir(), '.fdb2');
+  if (!fs.existsSync(dataDir)) {
+    fs.mkdirSync(dataDir, { recursive: true });
+  }
+  return path.join(dataDir, 'fdb2.config.json');
+}
+
+// 读取本地配置（容错：损坏时回退空对象）
+function readConfig() {
+  try {
+    const p = getConfigPath();
+    if (!fs.existsSync(p)) return {};
+    return JSON.parse(fs.readFileSync(p, 'utf8')) || {};
+  } catch {
+    return {};
+  }
+}
+
+// 写入本地配置
+function writeConfig(cfg) {
+  fs.writeFileSync(getConfigPath(), JSON.stringify(cfg, null, 2));
+}
+
 // 解析命令行参数
 const args = process.argv.slice(2);
 const command = args[0] || 'help';
@@ -66,10 +91,18 @@ switch (command) {
   case 'restart':
     restartProject();
     break;
+  case 'token':
+    handleTokenCommand(commandArgs);
+    break;
   case '-v':
   case '--version':
     showVersion();
     break;
+  case '-h':
+  case '--help':
+  case 'help':
+    showHelp();
+    break;
   default: {
     // 数据库命令（conn/db/table/rows/...）交给编译后的 CLI
     const cliMain = path.join(projectRoot, 'dist', 'server', 'cli', 'main.js');
@@ -198,6 +231,16 @@ async function startProject() {
   // 创建日志文件流
   const logFileFd = createLogFileStream(logFilePath);
   
+  // 注入远程访问令牌：若未通过环境变量显式指定，则从本地配置读取并写入子进程环境
+  if (!process.env.DB_TOOL_REMOTE_TOKEN) {
+    const cfg = readConfig();
+    if (cfg.remoteToken) {
+      process.env.DB_TOOL_REMOTE_TOKEN = cfg.remoteToken;
+      console.log('已从本地配置载入远程访问令牌。');
+    }
+  }
+  
+
   // 使用 node 命令启动服务器（异步，后台运行）
   const child = spawn(cmd, args, {
     cwd: projectRoot,
@@ -349,8 +392,40 @@ function showHelp() {
   console.log('FDB2 Database Tool');
   console.log('');
   console.log('Usage:');
-  console.log('  fdb2 start    Start the project');
-  console.log('  fdb2 stop     Stop the project');
-  console.log('  fdb2 restart  Restart the project');
+  console.log('  fdb2 start                 Start the project');
+  console.log('  fdb2 stop                  Stop the project');
+  console.log('  fdb2 restart               Restart the project');
+  console.log('  fdb2 token set <token>    Save remote access token to local config');
+  console.log('  fdb2 token get            Show the saved remote access token');
   console.log('');
+  console.log('数据库操作（连接/库表/数据/SQL 等）作为子命令使用，例如 `fdb2 conn`、`fdb2 db`。');
+  console.log('远程连接相关说明见 README 的「远程代理服务」章节。');
+}
+
+// 处理 token 子命令：set / get
+function handleTokenCommand(args) {
+  const sub = args[0];
+  if (sub === 'set') {
+    const value = args[1];
+    if (!value) {
+      console.error('用法: fdb2 token set <token>');
+      process.exitCode = 1;
+      return;
+    }
+    const cfg = readConfig();
+    cfg.remoteToken = value;
+    writeConfig(cfg);
+    console.log('远程访问令牌已保存到本地配置文件。');
+    console.log('下次执行 `fdb2 start` 时会自动应用到服务端。');
+  } else if (sub === 'get' || sub === 'view') {
+    const cfg = readConfig();
+    if (cfg.remoteToken) {
+      console.log(cfg.remoteToken);
+    } else {
+      console.log('（尚未设置远程访问令牌）');
+    }
+  } else {
+    console.error('用法: fdb2 token set <token> | fdb2 token get');
+    process.exitCode = 1;
+  }
 }