From 4709ff0876c04389a34b171e807b1d2f047a902f Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 20 Apr 2021 03:56:25 +0100 Subject: [PATCH] Bot Updating Documentation --- images/docker-wireshark.md | 46 ++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/images/docker-wireshark.md b/images/docker-wireshark.md index 5c8b73941..da89d37a8 100644 --- a/images/docker-wireshark.md +++ b/images/docker-wireshark.md @@ -1,6 +1,9 @@ --- title: wireshark --- + + + # [linuxserver/wireshark](https://github.com/linuxserver/docker-wireshark) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-wireshark.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-wireshark) @@ -13,7 +16,7 @@ title: wireshark [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-wireshark%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-wireshark/job/master/) [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fwireshark%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/wireshark/latest/index.html) -[Wireshark](https://www.wireshark.org/) 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. +[Wireshark](https://www.wireshark.org/) 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 @@ -29,6 +32,19 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## 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 @@ -61,7 +77,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=wireshark \ --net=host \ @@ -75,7 +91,6 @@ docker run -d \ ghcr.io/linuxserver/wireshark ``` - ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -87,6 +102,7 @@ Docker images are configured using parameters passed at runtime (such as those a | `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 | @@ -105,15 +121,13 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | Users home directory in the container, stores program settings and potentially dump files. | - - ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -124,7 +138,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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](https://en.wikipedia.org/wiki/Umask) 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`. @@ -133,32 +146,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## 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`. - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=wireshark&query=%24.mods%5B%27wireshark%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=wireshark "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") We publish various [Docker Mods](https://github.com/linuxserver/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: