Skip to content

Docs/fix readme docker version #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amartingarcia merged 3 commits into from
Jul 6, 2026
Merged

Docs/fix readme docker version #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6aea620
chore: add Dependabot for GitHub Actions and pip
amartingarcia Apr 12, 2026
c63d1ff
Merge branch 'main' of github.com-amartin:devops-ia/steampipe
amartingarcia Jul 6, 2026
efb0bcf
docs: Update v2.4.1 version to documentation files
amartingarcia Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Community Docker image for [Steampipe](https://steampipe.io) — use SQL to inst
# Run Steampipe as a service (PostgreSQL endpoint on port 9193)
docker run -d --name steampipe \
-p 9193:9193 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

# Install a plugin
Expand All @@ -41,10 +41,10 @@ psql -h localhost -p 9193 -U steampipe -d steampipe

```bash
# GitHub Container Registry
docker pull ghcr.io/devops-ia/steampipe:2.4.1
docker pull ghcr.io/devops-ia/steampipe:v2.4.1

# Docker Hub
docker pull devopsiaci/steampipe:2.4.1
docker pull devopsiaci/steampipe:v2.4.1
```

## Documentation
Expand Down
28 changes: 14 additions & 14 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-e STEAMPIPE_DATABASE_PASSWORD=supersecret \
-e STEAMPIPE_DATABASE_LISTEN=network \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand Down Expand Up @@ -57,7 +57,7 @@ docker run -d --name steampipe \
-e AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \
-e AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \
-e AWS_DEFAULT_REGION=us-east-1 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -68,7 +68,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$HOME/.aws:/home/steampipe/.aws:ro" \
-v "$PWD/aws.spc:/home/steampipe/.steampipe/config/aws.spc:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -86,7 +86,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$PWD/gcp.spc:/home/steampipe/.steampipe/config/gcp.spc:ro" \
-v "$PWD/service-account.json:/home/steampipe/.config/gcloud/application_default_credentials.json:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -108,7 +108,7 @@ connection "azure" {
docker run -d --name steampipe \
-p 9193:9193 \
-v "$PWD/azure.spc:/home/steampipe/.steampipe/config/azure.spc:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

docker exec steampipe steampipe plugin install azure
Expand All @@ -124,7 +124,7 @@ docker run -d --name steampipe \
-e AZURE_TENANT_ID=00000000-0000-0000-0000-000000000000 \
-e AZURE_CLIENT_ID=00000000-0000-0000-0000-000000000000 \
-e AZURE_CLIENT_SECRET=your-client-secret \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -145,7 +145,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$HOME/.kube:/home/steampipe/.kube:ro" \
-v "$PWD/kubernetes.spc:/home/steampipe/.steampipe/config/kubernetes.spc:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

docker exec steampipe steampipe plugin install kubernetes
Expand Down Expand Up @@ -175,7 +175,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$PWD/github.spc:/home/steampipe/.steampipe/config/github.spc:ro" \
-e GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

docker exec steampipe steampipe plugin install github
Expand Down Expand Up @@ -243,7 +243,7 @@ docker run -d --name steampipe \
-e STEAMPIPE_MEMORY_MAX_MB=4096 \
-e STEAMPIPE_PLUGIN_MEMORY_MAX_MB=2048 \
-e STEAMPIPE_MAX_PARALLEL=20 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -254,7 +254,7 @@ docker run -d --name steampipe \
--memory=6g --memory-swap=6g \
-p 9193:9193 \
-e STEAMPIPE_MEMORY_MAX_MB=4096 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -267,23 +267,23 @@ Steampipe caches query results to avoid redundant API calls. By default the cach
docker run -d --name steampipe \
-p 9193:9193 \
-e STEAMPIPE_CACHE=false \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

# Longer cache TTL for stable data (1 hour)
docker run -d --name steampipe \
-p 9193:9193 \
-e STEAMPIPE_CACHE=true \
-e STEAMPIPE_CACHE_TTL=3600 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

# Short TTL for near-real-time data (30 seconds)
docker run -d --name steampipe \
-p 9193:9193 \
-e STEAMPIPE_CACHE=true \
-e STEAMPIPE_CACHE_TTL=30 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -301,7 +301,7 @@ Control how many plugin API calls run concurrently:
docker run -d --name steampipe \
-p 9193:9193 \
-e STEAMPIPE_MAX_PARALLEL=20 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand Down
2 changes: 1 addition & 1 deletion docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,6 @@ Using Docker directly as a cron job:
docker run --rm \
-v "$HOME/.aws:/home/steampipe/.aws:ro" \
-v "$PWD/aws.spc:/home/steampipe/.steampipe/config/aws.spc:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe query "select name, region from aws_s3_bucket" --output json
```
10 changes: 5 additions & 5 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

```bash
# GitHub Container Registry (recommended)
docker pull ghcr.io/devops-ia/steampipe:2.4.1
docker pull ghcr.io/devops-ia/steampipe:v2.4.1

# Docker Hub
docker pull devopsiaci/steampipe:2.4.1
docker pull devopsiaci/steampipe:v2.4.1
```

## Run as a query shell
Expand All @@ -21,7 +21,7 @@ Execute a one-off interactive SQL session:

```bash
docker run -it --rm \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe query
```

Expand All @@ -32,7 +32,7 @@ Start Steampipe as a persistent background service accessible on port 9193:
```bash
docker run -d --name steampipe \
-p 9193:9193 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -55,7 +55,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v steampipe-data:/home/steampipe/.steampipe \
-e STEAMPIPE_DATABASE_PASSWORD=mypassword \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

# Install the AWS plugin
Expand Down
8 changes: 4 additions & 4 deletions docs/integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Connect Grafana to Steampipe using the built-in PostgreSQL datasource.
# docker-compose-grafana.yml
services:
steampipe:
image: ghcr.io/devops-ia/steampipe:2.4.1
image: ghcr.io/devops-ia/steampipe:v2.4.1
container_name: steampipe
command: steampipe service start --foreground --database-listen network
ports:
Expand Down Expand Up @@ -72,7 +72,7 @@ GROUP BY instance_state
# docker-compose-superset.yml
services:
steampipe:
image: ghcr.io/devops-ia/steampipe:2.4.1
image: ghcr.io/devops-ia/steampipe:v2.4.1
command: steampipe service start --foreground --database-listen network
ports:
- "9193:9193"
Expand Down Expand Up @@ -110,7 +110,7 @@ postgresql+psycopg2://steampipe:steampipe@steampipe:9193/steampipe
# docker-compose-metabase.yml
services:
steampipe:
image: ghcr.io/devops-ia/steampipe:2.4.1
image: ghcr.io/devops-ia/steampipe:v2.4.1
command: steampipe service start --foreground --database-listen network
ports:
- "9193:9193"
Expand Down Expand Up @@ -191,7 +191,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v steampipe-data:/home/steampipe/.steampipe \
-e STEAMPIPE_DATABASE_PASSWORD=steampipe \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

# Run dbt
Expand Down
18 changes: 9 additions & 9 deletions docs/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ docker run -d --name steampipe \
-e AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE \
-e AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY \
-e AWS_DEFAULT_REGION=us-east-1 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand Down Expand Up @@ -94,7 +94,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$HOME/.aws:/home/steampipe/.aws:ro" \
-v "$PWD/aws.spc:/home/steampipe/.steampipe/config/aws.spc:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand Down Expand Up @@ -123,7 +123,7 @@ docker run -d --name steampipe \
-e AZURE_TENANT_ID=00000000-0000-0000-0000-000000000000 \
-e AZURE_CLIENT_ID=00000000-0000-0000-0000-000000000000 \
-e AZURE_CLIENT_SECRET=your-client-secret \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -144,7 +144,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$PWD/gcp.spc:/home/steampipe/.steampipe/config/gcp.spc:ro" \
-v "$PWD/service-account.json:/home/steampipe/.config/gcloud/application_default_credentials.json:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand Down Expand Up @@ -174,7 +174,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$HOME/.kube:/home/steampipe/.kube:ro" \
-v "$PWD/kubernetes.spc:/home/steampipe/.steampipe/config/kubernetes.spc:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -193,7 +193,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$PWD/github.spc:/home/steampipe/.steampipe/config/github.spc:ro" \
-e GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -217,7 +217,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-v "$PWD:/workspace" \
-v "$PWD/terraform.spc:/home/steampipe/.steampipe/config/terraform.spc:ro" \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -241,7 +241,7 @@ docker volume create steampipe-data
docker run -d --name steampipe \
-p 9193:9193 \
-v steampipe-data:/home/steampipe/.steampipe \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

# Install plugins — they persist in steampipe-data volume
Expand All @@ -253,7 +253,7 @@ docker exec steampipe steampipe plugin install aws azure gcp
For faster cold starts, build a custom image with plugins pre-installed:

```dockerfile
FROM ghcr.io/devops-ia/steampipe:2.4.1
FROM ghcr.io/devops-ia/steampipe:v2.4.1

RUN steampipe plugin install aws azure gcp kubernetes
```
Expand Down
12 changes: 6 additions & 6 deletions docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@

```bash
# Wrong — exits after starting the background daemon
docker run ghcr.io/devops-ia/steampipe:2.4.1 steampipe service start
docker run ghcr.io/devops-ia/steampipe:v2.4.1 steampipe service start

# Correct — blocks in foreground (required for containers)
docker run ghcr.io/devops-ia/steampipe:2.4.1 \
docker run ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand All @@ -26,7 +26,7 @@ docker run ghcr.io/devops-ia/steampipe:2.4.1 \
```bash
# Must include --database-listen network to accept external connections
docker run -d -p 9193:9193 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand Down Expand Up @@ -61,7 +61,7 @@ docker volume create steampipe-data
docker run -d --name steampipe \
-p 9193:9193 \
-v steampipe-data:/home/steampipe/.steampipe \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

# Plugins installed now survive container recreation
Expand Down Expand Up @@ -110,7 +110,7 @@ docker run -d --name steampipe \
-p 9193:9193 \
-e STEAMPIPE_MEMORY_MAX_MB=3072 \
-e STEAMPIPE_PLUGIN_MEMORY_MAX_MB=2048 \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network
```

Expand Down Expand Up @@ -155,7 +155,7 @@ Enable detailed logging to diagnose unexpected behaviour:
docker run -d --name steampipe \
-p 9193:9193 \
-e STEAMPIPE_LOG_LEVEL=debug \
ghcr.io/devops-ia/steampipe:2.4.1 \
ghcr.io/devops-ia/steampipe:v2.4.1 \
steampipe service start --foreground --database-listen network

docker logs -f steampipe
Expand Down