1
0
mirror of https://github.com/amir20/dozzle.git synced 2025-12-25 14:59:26 +01:00

fix(docs): updates docs for shell

This commit is contained in:
Amir Raminfar
2025-03-31 13:41:24 -07:00
parent 9ae7c4cbd8
commit ddcc5ccbe1
5 changed files with 31 additions and 21 deletions

27
docs/guide/shell.md Normal file
View File

@@ -0,0 +1,27 @@
---
title: Container Shell Access
---
# Attaching and Executing Commands <Badge type="info" text="new" />
Dozzle supports attaching or executing commands within containers. It provides a web-based interface to interact with Docker containers, allowing users to attach to running containers and execute commands directly from the browser. This feature is particularly useful for debugging and troubleshooting containerized applications. This feature is **disabled** by default as it may pose security risks. To enable it, set the `DOZZLE_ENABLE_SHELL` environment variable to `true`.
::: code-group
```sh
docker run --volume=/var/run/docker.sock:/var/run/docker.sock -p 8080:8080 amir20/dozzle --enable-shell
```
```yaml [docker-compose.yml]
services:
dozzle:
image: amir20/dozzle:latest
volumes:
- /var/run/docker.sock:/var/run/docker.sock
ports:
- 8080:8080
environment:
DOZZLE_ENABLE_SHELL: true
```
:::