docker-smokeping/README.md
2016-07-25 14:11:56 +01:00

64 lines
2.5 KiB
Markdown

![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at:
* [forum.linuxserver.io](https://forum.linuxserver.io)
* [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`
* [Podcast](https://www.linuxserver.io/index.php/category/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/smokeping
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).
## Usage
```
docker create \
--name smokeping \
-p 8080:80 \
-e PUID=<UID> -e PGID=<GID> \
-e TZ=<timezone> \
-v <path/to/smokeping/data>:/data \
-v <path/to/smokeping/config>:/config \
linuxserver/smokeping
```
**Parameters**
* `-p 80` - the port for the webUI
* `-v /data` - Storage location for db and application data (graphs etc)
* `-v /config` - Configure the `Targets` file here
* `-e PGID` for for GroupID - see below for explanation
* `-e PUID` for for UserID - see below for explanation
* `-e TZ` for timezone setting, eg Europe/London
This container is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it smokeping /bin/bash`.
### User / Group Identifiers
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" <sup>TM</sup>.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
```
$ id dockeruser
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
## Setting up the application
Once running the URL will be `http://<host-ip>:8080/smokeping/smokeping.cgi`.
Basics are, edit the Targets file to ping the hosts you're interested in to match the format found there.
Wait 10 minutes.
## Info
* To monitor the logs of the container in realtime `docker logs -f smokeping`.
**Version**
+ **25.07.16:** Rebase to alpine linux.
+ **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)