codeharbor 0.1.1 → 0.1.2

package/.env.example

@@ -0,0 +1,78 @@
+MATRIX_HOMESERVER=https://matrix.biglone.tech
+MATRIX_USER_ID=@codeharbor-bot:example.com
+MATRIX_ACCESS_TOKEN=
+
+# Optional explicit trigger in groups; can be empty to disable prefix trigger.
+MATRIX_COMMAND_PREFIX=!code
+
+CODEX_BIN=codex
+CODEX_MODEL=
+CODEX_WORKDIR=/Users/biglone/workspace
+CODEX_DANGEROUS_BYPASS=false
+CODEX_EXEC_TIMEOUT_MS=600000
+CODEX_SANDBOX_MODE=
+CODEX_APPROVAL_POLICY=
+# Optional extra CLI args, space separated (example: --search --no-alt-screen)
+CODEX_EXTRA_ARGS=
+# Optional JSON object for additional environment variables passed to codex child process.
+CODEX_EXTRA_ENV_JSON=
+
+# SQLite state database path.
+STATE_DB_PATH=data/state.db
+# Legacy JSON path for one-time migration import.
+STATE_PATH=data/state.json
+
+MAX_PROCESSED_EVENTS_PER_SESSION=200
+MAX_SESSION_AGE_DAYS=30
+MAX_SESSIONS=5000
+REPLY_CHUNK_SIZE=3500
+
+MATRIX_PROGRESS_UPDATES=true
+MATRIX_PROGRESS_MIN_INTERVAL_MS=2500
+MATRIX_TYPING_TIMEOUT_MS=10000
+SESSION_ACTIVE_WINDOW_MINUTES=20
+
+# Group trigger defaults.
+GROUP_TRIGGER_ALLOW_MENTION=true
+GROUP_TRIGGER_ALLOW_REPLY=true
+GROUP_TRIGGER_ALLOW_ACTIVE_WINDOW=true
+GROUP_TRIGGER_ALLOW_PREFIX=true
+
+# Optional room-level trigger overrides (JSON object).
+# ROOM_TRIGGER_POLICY_JSON={"!room:example.com":{"allowMention":true,"allowReply":true,"allowActiveWindow":false,"allowPrefix":false}}
+ROOM_TRIGGER_POLICY_JSON=
+
+# Rate limiting / anti-abuse.
+RATE_LIMIT_WINDOW_SECONDS=60
+RATE_LIMIT_MAX_REQUESTS_PER_USER=20
+RATE_LIMIT_MAX_REQUESTS_PER_ROOM=120
+RATE_LIMIT_MAX_CONCURRENT_GLOBAL=8
+RATE_LIMIT_MAX_CONCURRENT_PER_USER=1
+RATE_LIMIT_MAX_CONCURRENT_PER_ROOM=4
+
+# CLI compatibility mode (IM shell approximation of codex CLI).
+CLI_COMPAT_MODE=false
+CLI_COMPAT_PASSTHROUGH_EVENTS=true
+CLI_COMPAT_PRESERVE_WHITESPACE=true
+CLI_COMPAT_DISABLE_REPLY_CHUNK_SPLIT=false
+CLI_COMPAT_PROGRESS_THROTTLE_MS=300
+CLI_COMPAT_FETCH_MEDIA=true
+# Optional JSONL output path for executed prompt recording (for replay benchmarking).
+CLI_COMPAT_RECORD_PATH=
+
+DOCTOR_HTTP_TIMEOUT_MS=10000
+
+# Admin API server (for config UI/backend).
+ADMIN_BIND_HOST=127.0.0.1
+ADMIN_PORT=8787
+# Token protection for /api/admin/* endpoints.
+# Strongly recommended for any non-localhost access.
+# Required when exposing admin via reverse proxy/tunnel/public domain.
+ADMIN_TOKEN=
+# Optional IP allowlist (comma-separated, for example: 127.0.0.1,192.168.1.10).
+ADMIN_IP_ALLOWLIST=
+# Optional browser origin allowlist for CORS (comma-separated).
+# Example: https://admin.example.com,https://ops.example.com
+ADMIN_ALLOWED_ORIGINS=
+
+LOG_LEVEL=info

package/README.md

@@ -49,6 +49,44 @@ Install globally from npm (after publish):
 npm install -g codeharbor
 ```
 
+Linux one-command install (creates `/opt/codeharbor`, sets ownership, installs latest package):
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/biglone/CodeHarbor/main/scripts/install-linux.sh | bash
+```
+
+Linux easy mode (install + write `.env` + enable/start systemd in one run):
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/biglone/CodeHarbor/main/scripts/install-linux-easy.sh | bash -s -- \
+  --matrix-homeserver https://matrix.example.com \
+  --matrix-user-id @bot:example.com \
+  --matrix-access-token 'your-token'
+```
+
+Enable Admin service at install time:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/biglone/CodeHarbor/main/scripts/install-linux-easy.sh | bash -s -- \
+  --matrix-homeserver https://matrix.example.com \
+  --matrix-user-id @bot:example.com \
+  --matrix-access-token 'your-token' \
+  --enable-admin-service \
+  --admin-token 'replace-with-strong-token'
+```
+
+Run local script with custom options:
+
+```bash
+./scripts/install-linux.sh --app-dir /srv/codeharbor --package codeharbor@0.1.1 --init
+```
+
+Runtime home behavior:
+
+- By default, all `codeharbor` commands use `/opt/codeharbor` for `.env` and relative data paths.
+- No manual `cd /opt/codeharbor` is required after installation.
+- To use a custom runtime directory, set `CODEHARBOR_HOME` (for example `export CODEHARBOR_HOME=/srv/codeharbor`).
+
 Install directly from GitHub:
 
 ```bash
@@ -133,6 +171,7 @@ npm install
 2. Configure environment:
 
 ```bash
+export CODEHARBOR_HOME="$(pwd)"
 codeharbor init
 ```
 
@@ -145,6 +184,7 @@ Required values:
 3. Run in dev mode:
 
 ```bash
+export CODEHARBOR_HOME="$(pwd)"
 npm run dev
 ```
 
@@ -152,6 +192,7 @@ npm run dev
 
 ```bash
 npm run build
+export CODEHARBOR_HOME="$(pwd)"
 node dist/cli.js start
 ```
 
@@ -176,6 +217,8 @@ It documents:
 - `codeharbor admin serve`: start admin UI + config API server
 - `codeharbor config export`: export current config snapshot as JSON
 - `codeharbor config import <file>`: import config snapshot JSON (supports `--dry-run`)
+- `scripts/install-linux.sh`: Linux bootstrap installer (creates runtime dir + installs npm package)
+- `scripts/install-linux-easy.sh`: one-shot Linux install + config + systemd auto-start
 - `scripts/backup-config.sh`: export timestamped snapshot and keep latest N backups
 - `scripts/install-backup-timer.sh`: install/update user-level systemd timer for automatic backups
 - `npm run test:e2e`: run Admin UI end-to-end tests (Playwright)

package/dist/cli.js

@@ -24,6 +24,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 
 // src/cli.ts
+var import_node_fs9 = __toESM(require("fs"));
+var import_node_path11 = __toESM(require("path"));
 var import_commander = require("commander");
 
 // src/app.ts
@@ -45,12 +47,9 @@ var import_dotenv = __toESM(require("dotenv"));
 async function runInitCommand(options = {}) {
   const cwd = options.cwd ?? process.cwd();
   const envPath = import_node_path.default.resolve(cwd, ".env");
-  const templatePath = import_node_path.default.resolve(cwd, ".env.example");
+  const templatePath = resolveInitTemplatePath(cwd);
   const input = options.input ?? process.stdin;
   const output = options.output ?? process.stdout;
-  if (!import_node_fs.default.existsSync(templatePath)) {
-    throw new Error(`Cannot find template file: ${templatePath}`);
-  }
   const templateContent = import_node_fs.default.readFileSync(templatePath, "utf8");
   const existingContent = import_node_fs.default.existsSync(envPath) ? import_node_fs.default.readFileSync(envPath, "utf8") : "";
   const existingValues = existingContent ? import_dotenv.default.parse(existingContent) : {};
@@ -142,6 +141,18 @@ async function runInitCommand(options = {}) {
     rl.close();
   }
 }
+function resolveInitTemplatePath(cwd) {
+  const candidates = [
+    import_node_path.default.resolve(cwd, ".env.example"),
+    import_node_path.default.resolve(__dirname, "..", ".env.example")
+  ];
+  for (const candidate of candidates) {
+    if (import_node_fs.default.existsSync(candidate)) {
+      return candidate;
+    }
+  }
+  throw new Error(`Cannot find template file. Tried: ${candidates.join(", ")}`);
+}
 function applyEnvOverrides(template, overrides) {
   const lines = template.split(/\r?\n/);
   const seen = /* @__PURE__ */ new Set();
@@ -4160,7 +4171,6 @@ var import_node_fs6 = __toESM(require("fs"));
 var import_node_path7 = __toESM(require("path"));
 var import_dotenv2 = __toESM(require("dotenv"));
 var import_zod = require("zod");
-import_dotenv2.default.config();
 var configSchema = import_zod.z.object({
   MATRIX_HOMESERVER: import_zod.z.string().url(),
   MATRIX_USER_ID: import_zod.z.string().min(1),
@@ -4168,7 +4178,7 @@ var configSchema = import_zod.z.object({
   MATRIX_COMMAND_PREFIX: import_zod.z.string().default("!code"),
   CODEX_BIN: import_zod.z.string().default("codex"),
   CODEX_MODEL: import_zod.z.string().optional(),
-  CODEX_WORKDIR: import_zod.z.string().default(process.cwd()),
+  CODEX_WORKDIR: import_zod.z.string().default("."),
   CODEX_DANGEROUS_BYPASS: import_zod.z.string().default("false").transform((v) => v.toLowerCase() === "true"),
   CODEX_EXEC_TIMEOUT_MS: import_zod.z.string().default("600000").transform((v) => Number.parseInt(v, 10)).pipe(import_zod.z.number().int().positive()),
   CODEX_SANDBOX_MODE: import_zod.z.string().optional(),
@@ -4266,6 +4276,13 @@ var configSchema = import_zod.z.object({
   adminAllowedOrigins: parseCsvList(v.ADMIN_ALLOWED_ORIGINS),
   logLevel: v.LOG_LEVEL
 }));
+function loadEnvFromFile(filePath = import_node_path7.default.resolve(process.cwd(), ".env"), env = process.env) {
+  import_dotenv2.default.config({
+    path: filePath,
+    processEnv: env,
+    quiet: true
+  });
+}
 function loadConfig(env = process.env) {
   const parsed = configSchema.safeParse(env);
   if (!parsed.success) {
@@ -4793,7 +4810,7 @@ async function runStartupPreflight(options = {}) {
       code: "missing_dotenv",
       check: ".env",
       message: `No .env file found at ${envPath}.`,
-      fix: "cp .env.example .env && codeharbor init"
+      fix: 'Run "codeharbor init" to create baseline config.'
     });
   }
   for (const key of REQUIRED_ENV_KEYS) {
@@ -4893,14 +4910,29 @@ function readEnv(env, key) {
   return env[key]?.trim() ?? "";
 }
 
+// src/runtime-home.ts
+var import_node_path10 = __toESM(require("path"));
+var DEFAULT_RUNTIME_HOME = "/opt/codeharbor";
+var RUNTIME_HOME_ENV_KEY = "CODEHARBOR_HOME";
+function resolveRuntimeHome(env = process.env) {
+  const configured = env[RUNTIME_HOME_ENV_KEY]?.trim();
+  if (configured) {
+    return import_node_path10.default.resolve(configured);
+  }
+  return DEFAULT_RUNTIME_HOME;
+}
+
 // src/cli.ts
+var runtimeHome = null;
 var program = new import_commander.Command();
 program.name("codeharbor").description("Instant-messaging bridge for Codex CLI sessions").version("0.1.0");
 program.command("init").description("Create or update .env via guided prompts").option("-f, --force", "overwrite existing .env without confirmation").action(async (options) => {
-  await runInitCommand({ force: options.force ?? false });
+  const home = ensureRuntimeHomeOrExit();
+  await runInitCommand({ force: options.force ?? false, cwd: home });
 });
 program.command("start").description("Start CodeHarbor service").action(async () => {
-  const config = await loadConfigWithPreflight("start");
+  const home = ensureRuntimeHomeOrExit();
+  const config = await loadConfigWithPreflight("start", home);
   if (!config) {
     process.exitCode = 1;
     return;
@@ -4919,7 +4951,8 @@ program.command("start").description("Start CodeHarbor service").action(async ()
   });
 });
 program.command("doctor").description("Check codex and matrix connectivity").action(async () => {
-  const config = await loadConfigWithPreflight("doctor");
+  const home = ensureRuntimeHomeOrExit();
+  const config = await loadConfigWithPreflight("doctor", home);
   if (!config) {
     process.exitCode = 1;
     return;
@@ -4932,6 +4965,7 @@ admin.command("serve").description("Start admin config API server").option("--ho
   "--allow-insecure-no-token",
   "allow serving admin API without ADMIN_TOKEN on non-loopback host (not recommended)"
 ).action(async (options) => {
+  ensureRuntimeHomeOrExit();
   const config = loadConfig();
   const host = options.host?.trim() || config.adminBindHost;
   const port = options.port ? parsePortOption(options.port, config.adminPort) : config.adminPort;
@@ -4962,7 +4996,8 @@ admin.command("serve").description("Start admin config API server").option("--ho
 });
 configCommand.command("export").description("Export config snapshot as JSON").option("-o, --output <path>", "write snapshot to file instead of stdout").action(async (options) => {
   try {
-    await runConfigExportCommand({ outputPath: options.output });
+    const home = ensureRuntimeHomeOrExit();
+    await runConfigExportCommand({ outputPath: options.output, cwd: home });
   } catch (error) {
     process.stderr.write(`Config export failed: ${formatError3(error)}
 `);
@@ -4971,9 +5006,11 @@ configCommand.command("export").description("Export config snapshot as JSON").op
 });
 configCommand.command("import").description("Import config snapshot from JSON").argument("<file>", "snapshot file path").option("--dry-run", "validate snapshot without writing changes").action(async (file, options) => {
   try {
+    const home = ensureRuntimeHomeOrExit();
     await runConfigImportCommand({
       filePath: file,
-      dryRun: options.dryRun ?? false
+      dryRun: options.dryRun ?? false,
+      cwd: home
     });
   } catch (error) {
     process.stderr.write(`Config import failed: ${formatError3(error)}
@@ -4985,8 +5022,8 @@ if (process.argv.length <= 2) {
   process.argv.push("start");
 }
 void program.parseAsync(process.argv);
-async function loadConfigWithPreflight(commandName) {
-  const preflight = await runStartupPreflight();
+async function loadConfigWithPreflight(commandName, runtimeHomePath) {
+  const preflight = await runStartupPreflight({ cwd: runtimeHomePath });
   if (preflight.issues.length > 0) {
     const report = formatPreflightReport(preflight, commandName);
     if (preflight.ok) {
@@ -5006,6 +5043,31 @@ async function loadConfigWithPreflight(commandName) {
     return null;
   }
 }
+function ensureRuntimeHomeOrExit() {
+  if (runtimeHome) {
+    return runtimeHome;
+  }
+  const home = resolveRuntimeHome();
+  try {
+    import_node_fs9.default.mkdirSync(home, { recursive: true });
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    process.stderr.write(`Runtime setup failed: cannot create ${home}. ${message}
+`);
+    process.exit(1);
+  }
+  try {
+    process.chdir(home);
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    process.stderr.write(`Runtime setup failed: cannot switch to ${home}. ${message}
+`);
+    process.exit(1);
+  }
+  loadEnvFromFile(import_node_path11.default.resolve(home, ".env"));
+  runtimeHome = home;
+  return runtimeHome;
+}
 function parsePortOption(raw, fallback) {
   const parsed = Number.parseInt(raw, 10);
   if (!Number.isFinite(parsed) || parsed < 1 || parsed > 65535) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeharbor",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Instant-messaging bridge for Codex CLI sessions",
   "license": "MIT",
   "main": "dist/cli.js",
@@ -17,6 +17,7 @@
   },
   "files": [
     "dist",
+    ".env.example",
     "README.md",
     "LICENSE"
   ],