Skip to content

Commit ca486cc

Browse files
authored
Create visual guide for VaultOS with screenshots
Added a visual guide with screenshots and descriptions for the VaultOS dashboard and container creation wizard.
1 parent cb67d92 commit ca486cc

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

screenshots/screenshot.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# VaultOS Screenshots & Visual Guide
2+
3+
## Dashboard Views
4+
5+
### Main Dashboard (`TUI1.png`, `TUI2.png`)
6+
The primary interface of VaultOS.
7+
- **Grid Layout**: Shows a responsive table of active containers.
8+
- **Columns**: Displays Container ID, Name, Status, OS Distribution, Desktop Environment, Host Port, and Expiration Timer.
9+
- **Status Bar**: Provides real-time feedback on Docker connection status (`🟢 Connected`), Engine API version, and a summary of Total/Running/Stopped containers.
10+
- **Toolbar**: Quick access buttons for creation and lifecycle management (`Create`, `Start`, `Stop`, `Delete`, `Refresh`).
11+
12+
---
13+
14+
## Container Creation Wizard
15+
16+
### Step 1: Mode Selection
17+
18+
#### Default Mode (`Default.png`)
19+
The standard, quick-start configuration.
20+
- **Name**: User defines a simple identifier (e.g., `dev-box`).
21+
- **Port**: Maps to a local host port (default `3001`).
22+
- **Mode Selected**: `Default` is chosen for a standardized, ephemeral Alpine/XFCE container.
23+
24+
#### Persistant Mode (`Persistant1.png`)
25+
For environments that require data retention.
26+
- **Mode Selected**: `Persistent`.
27+
- **Volume Path**: A host path is provided (e.g., `C:/data/config`) to ensure `/config` data survives container restarts.
28+
- **Advanced Options**: The checkbox "Enable Advanced Options" is visible, allowing further customization in Step 3.
29+
30+
#### Ephemeral Mode (`Epheremal1.png`)
31+
For temporary, disposable workspaces.
32+
- **Mode Selected**: `Ephemeral`.
33+
- **Timer Input**: A timer field appears (e.g., `30s`, `2h`) to set the lifespan of the container.
34+
35+
### Step 2: Distribution & Desktop (`Epheremal2.png`, `Persistant2.png`)
36+
Selecting the environment flavor.
37+
- **OS Distribution**: A dropdown allows selection of base Linux distros (Alpine, Ubuntu, Arch, Fedora, etc.).
38+
- **Desktop Environment**: Context-aware dropdown to choose the desktop interface (XFCE, KDE, MATE, i3).
39+
40+
### Step 3: Advanced Configuration (`Persistant3.png`)
41+
Only available in Persistent mode with "Advanced Options" checked.
42+
- **Custom User**: Allows replacing the default `abc` user with a custom username (e.g., `danish`).
43+
- **Home Mapping**: Maps a host directory to the custom user's home (e.g., `/data/home` -> `/home/danish`), ensuring full user persistence and correct permissions.

0 commit comments

Comments
 (0)