英文 |
+ 
中文
+
+ 英文 |
+ 中文
+
+
+#### 核心技术
+
+[](#)
+[](#)
+[](#)
+[](#)
+[](#)
+[](#)
+[](#)
+[](#)
+
+
+
+ 
+
+
+ 
+
+ 
+ 
+
+ 
+ 
+ 
+
+ +
+ +# 许可证 + +根据 Apache 2.0 许可证发布。更多信息请参见 LICENSE。 diff --git a/README.md b/README.md index 64fcca64..5fad8156 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # Repo Stats + +
+ English |
+ 中文
+
+
#### Top Technologies
+
[](#)
[](#)
[](#)
@@ -29,26 +37,34 @@ If you would like, you can support the project here!\
-Termix is an open-source, forever-free, self-hosted all-in-one server management platform. It provides a web-based solution for managing your servers and infrastructure through a single, intuitive interface. Termix offers SSH terminal access, SSH tunneling capabilities, and remote file editing, with many more tools to come.
+Termix is an open-source, forever-free, self-hosted all-in-one server management platform. It provides a web-based
+solution for managing your servers and infrastructure through a single, intuitive interface. Termix offers SSH terminal
+access, SSH tunneling capabilities, and remote file editing, with many more tools to come.
# Features
+
- **SSH Terminal Access** - Full-featured terminal with split-screen support (up to 4 panels) and tab system
- **SSH Tunnel Management** - Create and manage SSH tunnels with automatic reconnection and health monitoring
-- **Remote File Editor** - Edit files directly on remote servers with syntax highlighting, file management features (uploading, removing, renaming, deleting files)
+- **Remote File Editor** - Edit files directly on remote servers with syntax highlighting, file management features (
+ uploading, removing, renaming, deleting files)
- **SSH Host Manager** - Save, organize, and manage your SSH connections with tags and folders
- **Server Stats** - View CPU, memory, and HDD usage on any SSH server
- **User Authentication** - Secure user management with admin controls and OIDC and 2FA (TOTP) support
-- **Modern UI** - Clean interface built with React, Tailwind CSS, and Shadcn
+- **Modern UI** - Clean desktop/mobile friendly (in progress) interface built with React, Tailwind CSS, and Shadcn
- **Languages** - Built-in support for English and Chinese
+- **Improved Platform Support** - Now includes an installable Electron app (in progress) for desktop, with a dedicated
+ mobile app also planned.
# Planned Features
-- **Improved Admin Control** - Give more fine-grained control over user and admin permissions, share hosts, etc
-- **Theming** - Modify theming for all tools
-- **Improved Terminal Support** - Add more terminal protocols such as VNC and RDP (anyone who has experience in integrating RDP into a web-application similar to Apache Guacamole, please contact me by creating an issue)
-- **Mobile Support** - Support a mobile app or version of the Termix website to manage servers from your phone
+
+See [Projects](https://github.com/users/LukeGus/projects/3). If you are looking to contribute,
+see [Contributing](https://github.com/LukeGus/Termix/blob/main/CONTRIBUTING.md),
# Installation
-Visit the Termix [Docs](https://docs.termix.site/install) for more information on how to install Termix. Otherwise, view a sample docker-compose file here:
+
+Visit the Termix [Docs](https://docs.termix.site/install) for more information on how to install Termix. Otherwise, view
+a sample docker-compose file here:
+
```yaml
services:
termix:
@@ -64,11 +80,18 @@ services:
volumes:
termix-data:
- driver: local
+ driver: local
```
+Pre-built binaries are now available for download, including a Windows installer/portable app and a Linux portable app (
+built with Electron). See [Docs](http://localhost:5174/install#pre-built-binaries) for details. A native iOS/Android app
+is planned.
+
# Support
-If you need help with Termix, you can join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support channel. You can also open an issue or open a pull request on the [GitHub](https://github.com/LukeGus/Termix/issues) repo.
+
+If you need help with Termix, you can join the [Discord](https://discord.gg/jVQGdvHDrf) server and visit the support
+channel. You can also open an issue or open a pull request on the [GitHub](https://github.com/LukeGus/Termix/issues)
+repo.
# Show-off
@@ -90,4 +113,5 @@ If you need help with Termix, you can join the [Discord](https://discord.gg/jVQG
# License
+
Distributed under the Apache License Version 2.0. See LICENSE for more information.
diff --git a/components.json b/components.json
index 2082f482..8bfc737f 100644
--- a/components.json
+++ b/components.json
@@ -18,4 +18,4 @@
"hooks": "@/hooks"
},
"iconLibrary": "lucide"
-}
\ No newline at end of file
+}
diff --git a/docker/Dockerfile b/docker/Dockerfile
index 7a95cabb..92d774a6 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -6,7 +6,11 @@ RUN apk add --no-cache python3 make g++
COPY package*.json ./
-RUN npm ci --force && \
+ENV npm_config_target_platform=linux
+ENV npm_config_target_arch=x64
+ENV npm_config_target_libc=glibc
+
+RUN npm ci --force --ignore-scripts && \
npm cache clean --force
# Stage 2: Build frontend
@@ -23,6 +27,12 @@ WORKDIR /app
COPY . .
+ENV npm_config_target_platform=linux
+ENV npm_config_target_arch=x64
+ENV npm_config_target_libc=glibc
+
+RUN npm rebuild better-sqlite3 --force
+
RUN npm run build:backend
# Stage 4: Production dependencies
@@ -31,6 +41,10 @@ WORKDIR /app
COPY package*.json ./
+ENV npm_config_target_platform=linux
+ENV npm_config_target_arch=x64
+ENV npm_config_target_libc=glibc
+
RUN npm ci --only=production --ignore-scripts --force && \
npm cache clean --force
@@ -42,7 +56,13 @@ RUN apk add --no-cache python3 make g++
COPY package*.json ./
-RUN npm ci --only=production bcryptjs better-sqlite3 --force && \
+ENV npm_config_target_platform=linux
+ENV npm_config_target_arch=x64
+ENV npm_config_target_libc=glibc
+
+# Install native modules and compile them properly
+RUN npm ci --only=production --force && \
+ npm rebuild better-sqlite3 bcryptjs --force && \
npm cache clean --force
# Stage 6: Final image
@@ -57,14 +77,12 @@ RUN apk add --no-cache nginx gettext su-exec && \
COPY docker/nginx.conf /etc/nginx/nginx.conf
COPY --from=frontend-builder /app/dist /usr/share/nginx/html
-COPY --from=frontend-builder /app/public/locales /usr/share/nginx/html/locales
+COPY --from=frontend-builder /app/src/locales /usr/share/nginx/html/locales
RUN chown -R nginx:nginx /usr/share/nginx/html
WORKDIR /app
-COPY --from=production-deps /app/node_modules /app/node_modules
-COPY --from=native-builder /app/node_modules/bcryptjs /app/node_modules/bcryptjs
-COPY --from=native-builder /app/node_modules/better-sqlite3 /app/node_modules/better-sqlite3
+COPY --from=native-builder /app/node_modules /app/node_modules
COPY --from=backend-builder /app/dist/backend ./dist/backend
COPY package.json ./
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index a4c55fad..5e7ec7e9 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -12,4 +12,4 @@ services:
volumes:
termix-data:
- driver: local
\ No newline at end of file
+ driver: local
diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh
index d6f5033a..a45affd0 100644
--- a/docker/entrypoint.sh
+++ b/docker/entrypoint.sh
@@ -19,9 +19,9 @@ cd /app
export NODE_ENV=production
if command -v su-exec > /dev/null 2>&1; then
- su-exec node node dist/backend/starter.js
+ su-exec node node dist/backend/backend/starter.js
else
- su -s /bin/sh node -c "node dist/backend/starter.js"
+ su -s /bin/sh node -c "node dist/backend/backend/starter.js"
fi
echo "All services started"
diff --git a/docker/nginx.conf b/docker/nginx.conf
index 728aad3b..2a943a46 100644
--- a/docker/nginx.conf
+++ b/docker/nginx.conf
@@ -18,7 +18,7 @@ http {
index index.html index.htm;
}
- location /users/ {
+ location ~ ^/users(/.*)?$ {
proxy_pass http://127.0.0.1:8081;
proxy_http_version 1.1;
proxy_set_header Host $host;
@@ -27,7 +27,7 @@ http {
proxy_set_header X-Forwarded-Proto $scheme;
}
- location /version/ {
+ location ~ ^/version(/.*)?$ {
proxy_pass http://127.0.0.1:8081;
proxy_http_version 1.1;
proxy_set_header Host $host;
@@ -36,7 +36,7 @@ http {
proxy_set_header X-Forwarded-Proto $scheme;
}
- location /releases/ {
+ location ~ ^/releases(/.*)?$ {
proxy_pass http://127.0.0.1:8081;
proxy_http_version 1.1;
proxy_set_header Host $host;
@@ -45,7 +45,16 @@ http {
proxy_set_header X-Forwarded-Proto $scheme;
}
- location /alerts/ {
+ location ~ ^/alerts(/.*)?$ {
+ proxy_pass http://127.0.0.1:8081;
+ proxy_http_version 1.1;
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-Proto $scheme;
+ }
+
+ location ~ ^/credentials(/.*)?$ {
proxy_pass http://127.0.0.1:8081;
proxy_http_version 1.1;
proxy_set_header Host $host;
@@ -129,7 +138,16 @@ http {
proxy_set_header X-Forwarded-Proto $scheme;
}
- location /status/ {
+ location /health {
+ proxy_pass http://127.0.0.1:8081;
+ proxy_http_version 1.1;
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-Proto $scheme;
+ }
+
+ location ~ ^/status(/.*)?$ {
proxy_pass http://127.0.0.1:8085;
proxy_http_version 1.1;
proxy_set_header Host $host;
@@ -138,7 +156,7 @@ http {
proxy_set_header X-Forwarded-Proto $scheme;
}
- location /metrics/ {
+ location ~ ^/metrics(/.*)?$ {
proxy_pass http://127.0.0.1:8085;
proxy_http_version 1.1;
proxy_set_header Host $host;
diff --git a/electron-builder.json b/electron-builder.json
new file mode 100644
index 00000000..21bdb711
--- /dev/null
+++ b/electron-builder.json
@@ -0,0 +1,44 @@
+{
+ "appId": "com.termix.app",
+ "productName": "Termix",
+ "directories": {
+ "output": "release"
+ },
+ "files": [
+ "dist/**/*",
+ "electron/**/*",
+ "public/**/*",
+ "!**/node_modules/**/*",
+ "!src/**/*",
+ "!*.md",
+ "!tsconfig*.json",
+ "!vite.config.ts",
+ "!eslint.config.js"
+ ],
+ "asarUnpack": ["node_modules/node-fetch/**/*"],
+ "extraMetadata": {
+ "main": "electron/main.cjs"
+ },
+ "buildDependenciesFromSource": false,
+ "nodeGypRebuild": false,
+ "npmRebuild": false,
+ "win": {
+ "target": "nsis",
+ "icon": "public/icon.ico",
+ "executableName": "Termix"
+ },
+ "nsis": {
+ "oneClick": false,
+ "allowToChangeInstallationDirectory": true,
+ "artifactName": "${productName}-Setup-${version}.${ext}",
+ "createDesktopShortcut": true,
+ "createStartMenuShortcut": true,
+ "shortcutName": "Termix",
+ "uninstallDisplayName": "Termix"
+ },
+ "linux": {
+ "target": "AppImage",
+ "icon": "public/icon.png",
+ "category": "Development"
+ }
+}
diff --git a/electron/main.cjs b/electron/main.cjs
new file mode 100644
index 00000000..7c42cdf5
--- /dev/null
+++ b/electron/main.cjs
@@ -0,0 +1,334 @@
+const { app, BrowserWindow, shell, ipcMain } = require("electron");
+const path = require("path");
+const fs = require("fs");
+
+let mainWindow = null;
+
+const isDev = process.env.NODE_ENV === "development" || !app.isPackaged;
+
+const gotTheLock = app.requestSingleInstanceLock();
+if (!gotTheLock) {
+ console.log("Another instance is already running, quitting...");
+ app.quit();
+ process.exit(0);
+} else {
+ app.on("second-instance", (event, commandLine, workingDirectory) => {
+ console.log("Second instance detected, focusing existing window...");
+ if (mainWindow) {
+ if (mainWindow.isMinimized()) mainWindow.restore();
+ mainWindow.focus();
+ mainWindow.show();
+ }
+ });
+}
+
+function createWindow() {
+ mainWindow = new BrowserWindow({
+ width: 1200,
+ height: 800,
+ minWidth: 800,
+ minHeight: 600,
+ title: "Termix",
+ icon: isDev
+ ? path.join(__dirname, "..", "public", "icon.png")
+ : path.join(process.resourcesPath, "public", "icon.png"),
+ webPreferences: {
+ nodeIntegration: false,
+ contextIsolation: true,
+ webSecurity: !isDev,
+ preload: path.join(__dirname, "preload.js"),
+ },
+ show: false,
+ });
+
+ if (process.platform !== "darwin") {
+ mainWindow.setMenuBarVisibility(false);
+ }
+
+ if (isDev) {
+ mainWindow.loadURL("http://localhost:5173");
+ mainWindow.webContents.openDevTools();
+ } else {
+ const indexPath = path.join(__dirname, "..", "dist", "index.html");
+ console.log("Loading frontend from:", indexPath);
+ mainWindow.loadFile(indexPath);
+ }
+
+ mainWindow.once("ready-to-show", () => {
+ console.log("Window ready to show");
+ mainWindow.show();
+ });
+
+ mainWindow.webContents.on(
+ "did-fail-load",
+ (event, errorCode, errorDescription, validatedURL) => {
+ console.error(
+ "Failed to load:",
+ errorCode,
+ errorDescription,
+ validatedURL,
+ );
+ },
+ );
+
+ mainWindow.webContents.on("did-finish-load", () => {
+ console.log("Frontend loaded successfully");
+ });
+
+ mainWindow.on("close", (event) => {
+ if (process.platform === "darwin") {
+ event.preventDefault();
+ mainWindow.hide();
+ }
+ });
+
+ mainWindow.on("closed", () => {
+ mainWindow = null;
+ });
+
+ mainWindow.webContents.setWindowOpenHandler(({ url }) => {
+ shell.openExternal(url);
+ return { action: "deny" };
+ });
+}
+
+ipcMain.handle("get-app-version", () => {
+ return app.getVersion();
+});
+
+ipcMain.handle("get-platform", () => {
+ return process.platform;
+});
+
+ipcMain.handle("get-server-config", () => {
+ try {
+ const userDataPath = app.getPath("userData");
+ const configPath = path.join(userDataPath, "server-config.json");
+
+ if (fs.existsSync(configPath)) {
+ const configData = fs.readFileSync(configPath, "utf8");
+ return JSON.parse(configData);
+ }
+ return null;
+ } catch (error) {
+ console.error("Error reading server config:", error);
+ return null;
+ }
+});
+
+ipcMain.handle("save-server-config", (event, config) => {
+ try {
+ const userDataPath = app.getPath("userData");
+ const configPath = path.join(userDataPath, "server-config.json");
+
+ if (!fs.existsSync(userDataPath)) {
+ fs.mkdirSync(userDataPath, { recursive: true });
+ }
+
+ fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
+ return { success: true };
+ } catch (error) {
+ console.error("Error saving server config:", error);
+ return { success: false, error: error.message };
+ }
+});
+
+ipcMain.handle("test-server-connection", async (event, serverUrl) => {
+ try {
+ let fetch;
+ try {
+ fetch = globalThis.fetch || require("node:fetch");
+ } catch (e) {
+ const https = require("https");
+ const http = require("http");
+ const { URL } = require("url");
+
+ fetch = (url, options = {}) => {
+ return new Promise((resolve, reject) => {
+ const urlObj = new URL(url);
+ const isHttps = urlObj.protocol === "https:";
+ const client = isHttps ? https : http;
+
+ const req = client.request(
+ url,
+ {
+ method: options.method || "GET",
+ headers: options.headers || {},
+ timeout: options.timeout || 5000,
+ },
+ (res) => {
+ let data = "";
+ res.on("data", (chunk) => (data += chunk));
+ res.on("end", () => {
+ resolve({
+ ok: res.statusCode >= 200 && res.statusCode < 300,
+ status: res.statusCode,
+ text: () => Promise.resolve(data),
+ json: () => Promise.resolve(JSON.parse(data)),
+ });
+ });
+ },
+ );
+
+ req.on("error", reject);
+ req.on("timeout", () => {
+ req.destroy();
+ reject(new Error("Request timeout"));
+ });
+
+ if (options.body) {
+ req.write(options.body);
+ }
+ req.end();
+ });
+ };
+ }
+
+ const normalizedServerUrl = serverUrl.replace(/\/$/, "");
+
+ const healthUrl = `${normalizedServerUrl}/health`;
+
+ try {
+ const response = await fetch(healthUrl, {
+ method: "GET",
+ timeout: 5000,
+ });
+
+ if (response.ok) {
+ const data = await response.text();
+
+ if (
+ data.includes(") { className={cn("text-muted-foreground text-sm", className)} {...props} /> - ) + ); } function FormMessage({ className, ...props }: React.ComponentProps<"p">) { - const { error, formMessageId } = useFormField() - const body = error ? String(error?.message ?? "") : props.children + const { error, formMessageId } = useFormField(); + const body = error ? String(error?.message ?? "") : props.children; if (!body) { - return null + return null; } return ( @@ -150,7 +151,7 @@ function FormMessage({ className, ...props }: React.ComponentProps<"p">) { > {body}
- ) + ); } export { @@ -162,4 +163,4 @@ export { FormDescription, FormMessage, FormField, -} +}; diff --git a/src/components/ui/input.tsx b/src/components/ui/input.tsx index 03295ca6..b1a060f5 100644 --- a/src/components/ui/input.tsx +++ b/src/components/ui/input.tsx @@ -1,6 +1,6 @@ -import * as React from "react" +import * as React from "react"; -import { cn } from "@/lib/utils" +import { cn } from "@/lib/utils"; function Input({ className, type, ...props }: React.ComponentProps<"input">) { return ( @@ -11,11 +11,11 @@ function Input({ className, type, ...props }: React.ComponentProps<"input">) { "file:text-foreground placeholder:text-muted-foreground selection:bg-primary selection:text-primary-foreground dark:bg-input/30 border-input flex h-9 w-full min-w-0 rounded-md border bg-transparent px-3 py-1 text-base shadow-xs transition-[color,box-shadow] outline-none file:inline-flex file:h-7 file:border-0 file:bg-transparent file:text-sm file:font-medium disabled:pointer-events-none disabled:cursor-not-allowed disabled:opacity-50 md:text-sm", "focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px]", "aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive", - className + className, )} {...props} /> - ) + ); } -export { Input } +export { Input }; diff --git a/src/components/ui/label.tsx b/src/components/ui/label.tsx index ef7133a7..4ef28a9b 100644 --- a/src/components/ui/label.tsx +++ b/src/components/ui/label.tsx @@ -1,7 +1,7 @@ -import * as React from "react" -import * as LabelPrimitive from "@radix-ui/react-label" +import * as React from "react"; +import * as LabelPrimitive from "@radix-ui/react-label"; -import { cn } from "@/lib/utils" +import { cn } from "@/lib/utils"; function Label({ className, @@ -12,11 +12,11 @@ function Label({ data-slot="label" className={cn( "flex items-center gap-2 text-sm leading-none font-medium select-none group-data-[disabled=true]:pointer-events-none group-data-[disabled=true]:opacity-50 peer-disabled:cursor-not-allowed peer-disabled:opacity-50", - className + className, )} {...props} /> - ) + ); } -export { Label } +export { Label }; diff --git a/src/components/ui/password-input.tsx b/src/components/ui/password-input.tsx new file mode 100644 index 00000000..f1cd0066 --- /dev/null +++ b/src/components/ui/password-input.tsx @@ -0,0 +1,41 @@ +"use client"; + +import * as React from "react"; +import { Eye, EyeOff } from "lucide-react"; +import { Input } from "@/components/ui/input"; +import { cn } from "@/lib/utils"; + +interface PasswordInputProps + extends React.InputHTMLAttributes