Skip to content

Commit

Permalink
Bot Updating Templated Files
Browse files Browse the repository at this point in the history
  • Loading branch information
LinuxServer-CI committed Dec 2, 2024
1 parent e14dea6 commit 6ce163e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,13 @@ It is possible to install extra packages during container start using [universal
- INSTALL_PACKAGES=libfuse2|git|gdb
```
## Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>[!NOTE]
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml
Expand All @@ -181,7 +183,7 @@ services:
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/config:/config
- /path/to/wireshark/config:/config
ports:
- 3000:3000 #optional
- 3001:3001 #optional
Expand All @@ -201,7 +203,7 @@ docker run -d \
-e TZ=Etc/UTC \
-p 3000:3000 `#optional` \
-p 3001:3001 `#optional` \
-v /path/to/config:/config \
-v /path/to/wireshark/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/wireshark:latest
```
Expand All @@ -220,6 +222,7 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-v /config` | Users home directory in the container, stores program settings and potentially dump files. |
| `--security-opt seccomp=unconfined` | For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. |
| `--cap-add=NET_ADMIN` | Required to allow packet capture. |

### Portainer notice

Expand Down

0 comments on commit 6ce163e

Please sign in to comment.