ai-workspace-lab/xworkspace-console
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refresh repository readme

Browse Source
This commit is contained in:
Haitao Pan 2026-06-15 14:23:32 +08:00
parent a842aab5be
commit b81a026396
1 changed files with 63 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
README.md
View File

@ -1,21 +1,74 @@
# XWorkspace Console
`xworkspace-console` is now a desktop-and-console project centered on:
XWorkspace Console is the local AI workspace control plane for AI Workspace Lab. It brings together a React dashboard, Go status API, systemd user services, and XFCE desktop templates into one tabbed surface for services, runtime, terminal access, and workspace navigation.
- YAML configuration
- Go status collection API
- React + Vite + TypeScript dashboard
- systemd user services
- XFCE / GTK / XDG desktop templates
## About
Flutter, Dart, and the earlier static web shell have been removed from this repo.
- Single entry point for the workspace UI at `http://127.0.0.1:17000`
- Tab-first console for Workspace, services, runtime, and embedded tools
- Designed to coordinate local AI services, gateway access, and desktop bootstrap flows
- Backed by `dashboard/`, `api/`, `config/`, `scripts/`, and `docs/`
## Start TLDR
1. Start the all-in-one installer:
```bash
curl -sfL https://raw.githubusercontent.com/ai-workspace-lab/xworkspace-console/main/scripts/setup-ai-workspace-all-in-one.sh | bash -
```
2. Or launch the local desktop console:
```bash
./scripts/setup-xworkspace-desktop.sh
```
3. Open the console:
```text
http://127.0.0.1:17000
```
## Tab Pages
The console is organized around tabs so the workspace can switch between overview, services, and custom artifact views.
### Workspace and Service Tabs
- `Workspace` for the main overview
- `OpenClaw` for gateway access
- `LiteLLM` for model routing and provider administration
- `Vault` for secrets and auth
- `Terminal` for the embedded local shell
### Image / Video
Image and video workflows fit naturally as custom tabs inside the same console shell. This keeps artifact review, service switching, and runtime operations in one place instead of scattering them across separate apps.
![XWorkspace Console dashboard preview](./dashboard-preview.png)
![XWorkspace Console status dropdown](./dashboard-status-dropdown.png)
## Download
- Latest source: [GitHub repository](https://github.com/ai-workspace-lab/xworkspace-console)
- Releases: [GitHub Releases](https://github.com/ai-workspace-lab/xworkspace-console/releases)
- Bootstrap script: `scripts/setup-ai-workspace-all-in-one.sh`
- Offline installer docs: [`docs/OFFLINE_AI_WORKSPACE_INSTALLER.md`](docs/OFFLINE_AI_WORKSPACE_INSTALLER.md)
## Docs / Links
- [`docs/SETUP_AI_WORKSPACE_ALL_IN_ONE.md`](docs/SETUP_AI_WORKSPACE_ALL_IN_ONE.md)
- [`docs/OFFLINE_AI_WORKSPACE_INSTALLER.md`](docs/OFFLINE_AI_WORKSPACE_INSTALLER.md)
- [`docs/operations/service-port-plan.md`](docs/operations/service-port-plan.md)
- [`docs/designs/2026-06-07-ai-workspace-desktop-design.md`](docs/designs/2026-06-07-ai-workspace-desktop-design.md)
## Core Structure
- `config/xworkspace-desktop.yaml`
- single source of truth for desktop ports, browser choice, and service naming
- `scripts/`
- setup, reset, and browser launch helpers
- setup, reset, install, and browser launch helpers
- `config/xfce4/`
- XFCE panel, window manager, session, and shortcut templates
- `config/autostart/`
@ -25,7 +78,7 @@ Flutter, Dart, and the earlier static web shell have been removed from this repo
- `api/`
- Go API exposing `/health`, `/services`, and `/metrics/simple`
- `dashboard/`
- React + Vite + TypeScript dashboard MVP
- React + Vite + TypeScript dashboard
## Primary Service Name
@ -33,24 +86,6 @@ The repo standardizes on `xworkspace-console` as the main local control-plane UI
Older overlapping names such as `xworkspace-dashboard` and `xworkspace-portal` are treated as historical concepts, not separate primary services in this repo.
## Online Alignment
The live target host `ubuntu@xworkmate-bridge.svc.plus` currently aligns to `jp-xhttp-contabo.svc.plus`.
The real online service shapes used as reference here are:
- `xworkmate-bridge.service`
- `ExecStart=/home/ubuntu/.local/bin/xworkmate-go-core serve --listen 127.0.0.1:8787`
- `WorkingDirectory=/opt/cloud-neutral/xworkmate-bridge`
- `openclaw-gateway.service`
- `ExecStart=/home/ubuntu/.local/bin/openclaw gateway run --port 18789 --force`
- `WorkingDirectory=/home/ubuntu`
The local repo mirrors those startup patterns with:
- `xworkspace-bridge.service`
- `xworkspace-openclaw.service`
## Endpoint Plan
The canonical local Console endpoint is:
@ -68,31 +103,7 @@ Port ownership:
- `7681`: ttyd embedded terminal
- `7000`: deprecated legacy portal, do not use for new Console deployments
See `docs/operations/service-port-plan.md` for the live-host inspection and migration order.
## Quick Start
### AI Workspace All-in-One
Recommended public bootstrap entry:
```bash
curl -sfL https://raw.githubusercontent.com/ai-workspace-lab/xworkspace-console/main/scripts/setup-ai-workspace-all-in-one.sh | bash -
```
Advanced parameter examples are documented in [`docs/SETUP_AI_WORKSPACE_ALL_IN_ONE.md`](docs/SETUP_AI_WORKSPACE_ALL_IN_ONE.md).
### Local Desktop Console
```bash
./scripts/setup-xworkspace-desktop.sh
```
## Reset
```bash
./scripts/reset-xfce-profile.sh
```
See [`docs/operations/service-port-plan.md`](docs/operations/service-port-plan.md) for the live-host inspection and migration order.
## Notes