linuxserver/wireshark

​linuxserver/wireshark​
​​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​​
​Wireshark is the world’s foremost and widely-used network protocol analyzer. It lets you see what’s happening on your network at a microscopic level and is the de facto (and often de jure) standard across many commercial and non-profit enterprises, government agencies, and educational institutions. Wireshark development thrives thanks to the volunteer contributions of networking experts around the globe and is the continuation of a project started by Gerald Combs in 1998.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/wireshark:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Available
Tag
x86-64
✅
amd64-<version tag>
arm64
✅
arm64v8-<version tag>
armhf
✅
arm32v7-<version tag>
Application Setup
The application can be accessed at:
http://yourhost:3000/
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
http://yourhost:3000/?login=true
In order to dump from an interface you will need to pass NET_ADMIN at a minimum, optionally you can use host networking to capture from your host level device or specify a Docker network you want to capture from.
If you do not specificy host networking you will need to map port 3000 with -p 3000:3000.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
1
---
2
version: "2.1"
3
services:
4
  wireshark:
5
    image: lscr.io/linuxserver/wireshark:latest
6
    container_name: wireshark
7
    cap_add:
8
      - NET_ADMIN
9
    network_mode: host
10
    environment:
11
      - PUID=1000
12
      - PGID=1000
13
      - TZ=Europe/London
14
    volumes:
15
      - /path/to/config:/config
16
    ports:
17
      - 3000:3000 #optional
18
    restart: unless-stopped
Copied!
docker cli (click here for more info)
1
docker run -d \
2
  --name=wireshark \
3
  --net=host \
4
  --cap-add=NET_ADMIN \
5
  -e PUID=1000 \
6
  -e PGID=1000 \
7
  -e TZ=Europe/London \
8
  -p 3000:3000 `#optional` \
9
  -v /path/to/config:/config \
10
  --restart unless-stopped \
11
  lscr.io/linuxserver/wireshark:latest
Copied!
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
Ports (-p)
Parameter
Function
3000
WireShark desktop gui, only use this if you are not using host mode and sniffing Docker network traffic.
Networking (--net)
Parameter
Function
--net=host
Use Host Networking
Environment Variables (-e)
Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Europe/London
Specify a timezone to use EG Europe/London.
Volume Mappings (-v)
Volume
Function
/config
Users home directory in the container, stores program settings and potentially dump files.
Miscellaneous Options
Portainer notice
This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
1
  $ id username
2
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!
Docker Mods
​​
​ ​
​​
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
Shell access whilst the container is running:
docker exec -it wireshark /bin/bash
To monitor the logs of the container in realtime:
docker logs -f wireshark
Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wireshark
Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wireshark:latest
Versions
14.02.22: - Rebase to Alpine.
31.03.20: - Initial release.