mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/9/head
LinuxServer-CI 2019-10-07 18:49:21 +01:00
rodzic a1b96685aa
commit d6f141c316
1 zmienionych plików z 36 dodań i 24 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

60
images/docker-smokeping.md
Wyświetl plik

@ -1,6 +1,12 @@
# linuxserver/smokeping # [linuxserver/smokeping](https://github.com/linuxserver/docker-smokeping)
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/smokeping.svg)](https://microbadger.com/images/linuxserver/smokeping) [![](https://images.microbadger.com/badges/image/linuxserver/smokeping.svg)](https://microbadger.com/images/linuxserver/smokeping) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/smokeping.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/smokeping.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-smokeping/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-smokeping/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/index.html) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-smokeping.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-smokeping/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/smokeping.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/smokeping "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/smokeping.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/smokeping "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/smokeping.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/smokeping)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/smokeping.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/smokeping)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-smokeping/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-smokeping/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/index.html)
[Smokeping](https://oss.oetiker.ch/smokeping/) keeps track of your network latency. For a full example of what this application is capable of visit [UCDavis](http://smokeping.ucdavis.edu/cgi-bin/smokeping.fcgi). [Smokeping](https://oss.oetiker.ch/smokeping/) keeps track of your network latency. For a full example of what this application is capable of visit [UCDavis](http://smokeping.ucdavis.edu/cgi-bin/smokeping.fcgi).
@ -13,18 +19,19 @@ Simply pulling `linuxserver/smokeping` should retrieve the correct image for you
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v7-latest | | armhf | arm32v7-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=smokeping \ --name=smokeping \
-e PUID=1000 \ -e PUID=1000 \
@ -37,6 +44,7 @@ docker create \
linuxserver/smokeping linuxserver/smokeping
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -62,55 +70,60 @@ services:
## Parameters ## 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. 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`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
| `80` | Allows HTTP access to the internal webserver. | | `80` | Allows HTTP access to the internal webserver. |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Configure the `Targets` file here | | `/config` | Configure the `Targets` file here |
| `/data` | Storage location for db and application data \(graphs etc\) | | `/data` | Storage location for db and application data (graphs etc) |
## User / Group Identifiers ## 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`. 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. 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: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## Application Setup
* Once running the URL will be `http://<host-ip>/`. - Once running the URL will be `http://<host-ip>/`.
* Basics are, edit the `Targets` file to ping the hosts you're interested in to match the format found there. - Basics are, edit the `Targets` file to ping the hosts you're interested in to match the format found there.
* Wait 10 minutes. - Wait 10 minutes.
## Support Info ## Support Info
* Shell access whilst the container is running: * Shell access whilst the container is running:
* `docker exec -it smokeping /bin/bash` * `docker exec -it smokeping /bin/bash`
* To monitor the logs of the container in realtime: * To monitor the logs of the container in realtime:
* `docker logs -f smokeping` * `docker logs -f smokeping`
* Container version number * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' smokeping` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' smokeping`
* Image version number * Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/smokeping` * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/smokeping`
@ -123,8 +136,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
* **14.11.18:** - Allow access without /smokeping in URL. * **14.11.18:** - Allow access without /smokeping in URL.
* **28.04.18:** - Rebase to alpine 3.8. * **28.04.18:** - Rebase to alpine 3.8.
* **09.04.18:** - Add bc package. * **09.04.18:** - Add bc package.
* **08.04.18:** - Add tccping script and tcptraceroute package \(thanks rcarmo\). * **08.04.18:** - Add tccping script and tcptraceroute package (thanks rcarmo).
* **13.12.17:** - Expose httpd\_conf to /config. * **13.12.17:** - Expose httpd_conf to /config.
* **13.12.17:** - Rebase to alpine 3.7. * **13.12.17:** - Rebase to alpine 3.7.
* **24.07.17:** - Add :unraid tag for hosts without ipv6. * **24.07.17:** - Add :unraid tag for hosts without ipv6.
* **12.07.17:** - Add inspect commands to README, move to jenkins build and push. * **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
@ -138,5 +151,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
* **28.08.16:** - Add badges to README. * **28.08.16:** - Add badges to README.
* **25.07.16:** - Rebase to alpine linux. * **25.07.16:** - Rebase to alpine linux.
* **23.07.16:** - Fix apt script confusion. * **23.07.16:** - Fix apt script confusion.
* **29.06.15:** - This is the first release, it is mostly stable, but may contain minor defects. \(thus a beta tag\) * **29.06.15:** - This is the first release, it is mostly stable, but may contain minor defects. (thus a beta tag)