Files
sencho/docs/features/resources.mdx
T
Anso f516275834 refactor(licensing): replace Pro branding with Community/Skipper/Admiral tiers (#375)
Eliminate all references to "Pro" across backend, frontend, and docs.
Internal tier value renamed from 'pro' to 'paid'; user-facing text now
uses the thematic tier names (Community, Skipper, Admiral).

- Rename LicenseTier 'pro' to 'paid' in backend and frontend types
- Rename requirePro guard to requirePaid, error code PRO_REQUIRED to PAID_REQUIRED
- Rename ProGate.tsx to PaidGate.tsx with updated copy
- Fix: trial users can now see upgrade/purchase cards in Settings
- Update all docs and openapi.yaml to use correct tier names
2026-04-05 05:59:36 -04:00

129 lines
5.5 KiB
Plaintext

---
title: Resources Hub
description: Browse, filter, and clean up Docker images, volumes, networks, and unmanaged containers.
---
The **Resources** tab gives you a full view of everything Docker is storing on your host, broken down by type and ownership.
<Frame>
<img src="/images/resources/resources-overview.png" alt="Resources Hub showing disk footprint, quick clean panel, and images table" />
</Frame>
## Docker disk footprint
The stacked bar at the top visualizes how your Docker disk usage is distributed:
| Segment | Meaning |
|---------|---------|
| **Sencho Managed** (green) | Images used by stacks in your `COMPOSE_DIR` |
| **External Projects** (orange) | Images used by Docker projects outside Sencho |
| **Reclaimable** (gray) | Unused images and dangling layers safe to delete |
Click any segment to automatically filter the tabs below to that category.
## Quick Clean panel
Four prune buttons let you reclaim disk space immediately. By default they operate on **Sencho-managed resources only**, so they will not touch external Docker projects.
| Button | What it removes |
|--------|----------------|
| **Prune Unused Images** | Images with no running containers in Sencho stacks |
| **Prune Unused Volumes** | Volumes not attached to any Sencho container |
| **Prune Dead Networks** | Networks not connected to any Sencho container |
| **Purge Unmanaged Containers** | Containers Sencho doesn't recognize (started outside it) |
The first three buttons have a **More options** dropdown that lets you target **all Docker resources** instead of Sencho-only. Use this carefully, as it can affect other Compose projects running on the same host. The "Purge Unmanaged Containers" button always targets unmanaged containers only.
A confirmation dialog appears before any destructive operation, showing a summary of what will be removed.
## Resource tabs
### Images
Lists all Docker images on the host with their ID, repository tag, size, and status.
**Filter buttons:** `All` / `Managed` / `External`
**Status badges:**
- `In Use` + stack name - image is actively used by a running container in a Sencho-managed stack
- `In Use` + `External` - image is used by a container outside Sencho
- `Unused` - image has no running containers; safe to delete
Click the trash icon on any row to delete an individual image. Sencho will warn you if the image is in use.
### Volumes
Lists all Docker volumes. Columns: name, driver, mount point, size, and managed status.
**Filter buttons:** `All` / `Managed` / `External`
<Warning>
Deleting a volume is permanent. Any data stored in it will be lost. Always back up important volume data before pruning.
</Warning>
### Networks
Lists all Docker networks. Columns: ID, name, driver, scope (`local`, `global`, `swarm`), and managed status.
**Filter buttons:** `All` / `Managed` / `External`
System networks (like `bridge`, `host`, `none`) are shown but cannot be deleted.
<Frame>
<img src="/images/networks/networks-list.png" alt="Networks list view with filter, inspect, and create actions" />
</Frame>
#### Create network
Click **+ Create Network** (admin only) to open the creation dialog.
<Frame>
<img src="/images/networks/create-network.png" alt="Create Network dialog with name, driver, subnet, and gateway fields" />
</Frame>
| Field | Required | Description |
|-------|----------|-------------|
| **Name** | Yes | Alphanumeric, hyphens, underscores, and dots |
| **Driver** | No | `bridge` (default), `overlay`, `macvlan`, `host`, or `none` |
| **Subnet** | No | CIDR notation, e.g. `172.20.0.0/16` |
| **Gateway** | No | Gateway IP, e.g. `172.20.0.1` |
| **Internal** | No | Isolates the network from external access |
| **Attachable** | No | Allows containers to be manually attached |
#### Inspect network
Click the eye icon on any network row to open a detail panel showing:
- **Overview** - ID, driver, scope, creation date, internal/attachable flags
- **IPAM configuration** - Subnet, gateway, and IP range
- **Connected containers** - Container name, IPv4 address, and MAC address
- **Labels** - All Docker labels applied to the network
<Frame>
<img src="/images/networks/network-inspect.png" alt="Network inspect panel showing IPAM config and connected containers" />
</Frame>
#### Network topology <span style={{fontSize: '0.75em', color: 'var(--brand)'}}>Skipper</span>
Switch to the **Topology** view to see an interactive graph of your Docker networks and the containers connected to them. System networks (`bridge`, `host`, `none`) are excluded for clarity.
<Frame>
<img src="/images/networks/network-topology.png" alt="Network topology visualization showing containers connected to networks" />
</Frame>
- **Network nodes** - Dashed border cards showing network name and driver, color-coded by status (managed, external, system)
- **Container nodes** - Cards showing container name with IP addresses per network
- **Edges** - Animated connections between networks and their containers
- Pan, zoom, and drag nodes to explore the topology
- A mini map in the bottom-right provides an overview
<Note>
Network Topology requires a Skipper or Admiral license. Community users see an upgrade prompt.
</Note>
### Unmanaged
Lists containers running on the host that are not part of any Sencho-managed stack. This includes containers started with `docker run`, or Compose projects outside your `COMPOSE_DIR`.
This view is useful for identifying orphaned containers after a failed deployment or after moving stacks in and out of `COMPOSE_DIR`. A badge on the tab shows the count of unmanaged containers when any are detected.