2020-06-29 07:29:55 +00:00
# linuxserver/smokeping
[](https://github.com/linuxserver/docker-smokeping) [](https://github.com/linuxserver/docker-smokeping/releases) [](https://github.com/linuxserver/docker-smokeping/packages) [](https://gitlab.com/Linuxserver.io/docker-smokeping/container_registry) [](https://microbadger.com/images/linuxserver/smokeping) [](https://hub.docker.com/r/linuxserver/smokeping) [](https://hub.docker.com/r/linuxserver/smokeping) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-smokeping/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/index.html)
2019-02-08 16:04:14 +00:00
[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 ).
## Supported Architectures
2019-09-29 09:44:22 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-08 16:04:14 +00:00
2019-02-15 16:03:43 +00:00
Simply pulling `linuxserver/smokeping` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-08 16:04:14 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-08 16:04:14 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:27:12 +00:00
| armhf | arm32v7-latest |
2019-02-08 16:04:14 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-06-29 07:29:55 +00:00
```text
2019-02-08 16:04:14 +00:00
docker create \
--name=smokeping \
2019-03-08 16:03:41 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-08 16:04:14 +00:00
-e TZ=Europe/London \
-p 80:80 \
-v < /path/to/smokeping/config>:/config \
-v < /path/to/smokeping/data>:/data \
--restart unless-stopped \
linuxserver/smokeping
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-10 15:04:34 +00:00
version: "2.1"
2019-02-08 16:04:14 +00:00
services:
smokeping:
image: linuxserver/smokeping
container_name: smokeping
environment:
2019-03-08 16:03:41 +00:00
- PUID=1000
- PGID=1000
2019-02-08 16:04:14 +00:00
- TZ=Europe/London
volumes:
- < /path/to/smokeping/config>:/config
- < /path/to/smokeping/data>:/data
ports:
- 80:80
restart: unless-stopped
```
## Parameters
2020-06-29 07:29:55 +00:00
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.
2019-02-08 16:04:14 +00:00
2020-06-29 07:29:55 +00:00
### Ports \(`-p`\)
2019-02-08 16:04:14 +00:00
| Parameter | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-08 16:04:14 +00:00
| `80` | Allows HTTP access to the internal webserver. |
2020-06-29 07:29:55 +00:00
### Environment Variables \(`-e`\)
2019-02-08 16:04:14 +00:00
| Env | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-03-08 16:03:41 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-08 16:04:14 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2020-06-29 07:29:55 +00:00
### Volume Mappings \(`-v`\)
2019-02-08 16:04:14 +00:00
| Volume | Function |
2020-06-29 07:29:55 +00:00
| :---: | :--- |
2019-02-08 16:04:14 +00:00
| `/config` | Configure the `Targets` file here |
2020-06-29 07:29:55 +00:00
| `/data` | Storage location for db and application data \(graphs etc\) |
2020-05-01 15:04:08 +00:00
2020-06-29 07:29:55 +00:00
## Environment variables from files \(Docker secrets\)
2020-05-29 15:03:53 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-06-29 07:29:55 +00:00
```text
2020-05-29 15:03:53 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-06-29 07:29:55 +00:00
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.
2020-04-10 15:04:34 +00:00
2019-02-08 16:04:14 +00:00
## User / Group Identifiers
2020-06-29 07:29:55 +00:00
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` .
2019-02-08 16:04:14 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-08 16:03:41 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-08 16:04:14 +00:00
2020-06-29 07:29:55 +00:00
```text
2019-02-08 16:04:14 +00:00
$ id username
2019-03-08 16:03:41 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-08 16:04:14 +00:00
```
## Application Setup
2020-06-29 07:29:55 +00:00
* 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.
* Wait 10 minutes.
2019-10-07 17:49:21 +00:00
2020-04-10 15:04:34 +00:00
## Docker Mods
2020-06-29 07:29:55 +00:00
[](https://mods.linuxserver.io/?mod=smokeping)
2020-04-10 15:04:34 +00:00
2020-06-29 07:29:55 +00:00
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\) can be accessed via the dynamic badge above.
2019-02-08 16:04:14 +00:00
## Support Info
2019-10-07 17:49:21 +00:00
* Shell access whilst the container is running:
2019-02-08 16:04:14 +00:00
* `docker exec -it smokeping /bin/bash`
2019-10-07 17:49:21 +00:00
* To monitor the logs of the container in realtime:
2019-02-08 16:04:14 +00:00
* `docker logs -f smokeping`
2019-10-07 17:49:21 +00:00
* Container version number
2019-02-08 16:04:14 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' smokeping`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/smokeping`
## Versions
2019-12-27 10:59:01 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-07-05 20:00:26 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 19:27:12 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 05:25:18 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-08 16:04:14 +00:00
* **14.11.18:** - Allow access without /smokeping in URL.
* **28.04.18:** - Rebase to alpine 3.8.
* **09.04.18:** - Add bc package.
2020-06-29 07:29:55 +00:00
* **08.04.18:** - Add tccping script and tcptraceroute package \(thanks rcarmo\).
* **13.12.17:** - Expose httpd\_conf to /config.
2019-02-08 16:04:14 +00:00
* **13.12.17:** - Rebase to alpine 3.7.
* **24.07.17:** - Add :unraid tag for hosts without ipv6.
* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
* **28.05.17:** - Rebase to alpine 3.6.
* **07.05.17:** - Expose smokeping.conf in /config/site-confs to allow user customisations
* **12.04.17:** - Fix cropper.js path, thanks nibbledeez.
* **09.02.17:** - Rebase to alpine 3.5.
* **17.10.16:** - Add ttf-dejavu package as per [LT forum ](http://lime-technology.com/forum/index.php?topic=43602.msg507875#msg507875 ).
* **10.09.16:** - Add layer badges to README.
* **05.09.16:** - Add curl package.
* **28.08.16:** - Add badges to README.
* **25.07.16:** - Rebase to alpine linux.
* **23.07.16:** - Fix apt script confusion.
2020-06-29 07:29:55 +00:00
* **29.06.15:** - This is the first release, it is mostly stable, but may contain minor defects. \(thus a beta tag\)
