Skip to content

Commit f20632d

Browse files
committed
docs: add docker socket discovery documentation
1 parent a33a767 commit f20632d

2 files changed

Lines changed: 23 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,12 @@ Key components:
8989
* **`DockerImageBuilder`**
9090
* Builds container images using Bollard (Docker API client).
9191

92+
* **`docker_socket_discovery`**
93+
* Automatically discovers and connects to Docker-compatible sockets.
94+
* Supports multiple socket locations: standard Docker, Colima, Lima, containerd, and Podman.
95+
* Checks sockets in priority order: `DOCKER_HOST` env var, `/var/run/docker.sock`, `$HOME/.colima/docker.sock`, `$HOME/.colima/default/docker.sock`, `$HOME/.colima/default/containerd.sock`, `$HOME/.lima/default/sock/docker.sock`, and `$XDG_RUNTIME_DIR/podman/podman.sock`.
96+
* Uses the first available and connectable socket.
97+
9298
* **Dockerfile / Compose / K8s Manifest AST Parsers**
9399
* Parse Dockerfiles to extract image references from `FROM` instructions (including multi-stage builds).
94100
* Parse Docker Compose YAML (e.g. service `image:` fields).

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,29 @@ The result of the compilation will be saved in `./result/bin`.
114114

115115
## Configuration Options
116116

117-
Sysdig LSP supports two configuration options for connecting to Sysdigs services:
117+
Sysdig LSP supports two configuration options for connecting to Sysdig's services:
118118

119119
| **Option** | **Description** | **Example Value** |
120120
|--------------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------|
121121
| `sysdig.api_url` | The URL endpoint for Sysdig's API. Set this to your instance's API endpoint. | `https://secure.sysdig.com` |
122122
| `sysdig.api_token` | The API token for authentication. If omitted, the `SECURE_API_TOKEN` environment variable is used instead. | `"your token"` (if required) |
123123

124+
### Docker Socket Discovery
125+
126+
For features that require building Docker images (e.g., "Build and Scan"), Sysdig LSP automatically discovers and connects to available Docker-compatible sockets. The following locations are checked in order:
127+
128+
| **Priority** | **Socket Path** | **Description** |
129+
|--------------|----------------------------------------------|-------------------------------------------|
130+
| 1 | `DOCKER_HOST` env var | If set, uses the specified socket/URL |
131+
| 2 | `/var/run/docker.sock` | Standard Docker socket (Linux/macOS) |
132+
| 3 | `$HOME/.colima/docker.sock` | Colima Docker socket |
133+
| 4 | `$HOME/.colima/default/docker.sock` | Colima default profile Docker socket |
134+
| 5 | `$HOME/.colima/default/containerd.sock` | Colima containerd socket (Docker-compat) |
135+
| 6 | `$HOME/.lima/default/sock/docker.sock` | Lima Docker socket |
136+
| 7 | `$XDG_RUNTIME_DIR/podman/podman.sock` | Podman socket |
137+
138+
The first available and connectable socket will be used. If you're using Colima or another Docker-compatible runtime, no additional configuration is needed.
139+
124140
## Editor Configurations
125141

126142
Below are detailed instructions for configuring Sysdig LSP in various editors.

0 commit comments

Comments
 (0)