From 571b33607d0e881a5f07035b0f67536e12358dde Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 8 Feb 2019 16:04:14 +0000 Subject: [PATCH] Bot Updating Templated Files --- images/docker-smokeping.md | 149 +++++++++++++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100755 images/docker-smokeping.md diff --git a/images/docker-smokeping.md b/images/docker-smokeping.md new file mode 100755 index 000000000..530092267 --- /dev/null +++ b/images/docker-smokeping.md @@ -0,0 +1,149 @@ +# [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 "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/smokeping.svg)](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) +![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) + +[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 + +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). + +The architectures supported by this image are: + +| Architecture | Tag | +| :----: | --- | +| x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v6-latest | + + +## Usage + +Here are some example snippets to help you get started creating a container from this image. + +### docker + +``` +docker create \ + --name=smokeping \ + -e PUID=1001 \ + -e PGID=1001 \ + -e TZ=Europe/London \ + -p 80:80 \ + -v :/config \ + -v :/data \ + --restart unless-stopped \ + linuxserver/smokeping +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + smokeping: + image: linuxserver/smokeping + container_name: smokeping + environment: + - PUID=1001 + - PGID=1001 + - TZ=Europe/London + volumes: + - :/config + - :/data + ports: + - 80:80 + mem_limit: 4096m + restart: unless-stopped +``` + +## 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. + +### Ports (`-p`) + +| Parameter | Function | +| :----: | --- | +| `80` | Allows HTTP access to the internal webserver. | + + +### Environment Variables (`-e`) + +| Env | Function | +| :----: | --- | +| `PUID=1001` | for UserID - see below for explanation | +| `PGID=1001` | for GroupID - see below for explanation | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Configure the `Targets` file here | +| `/data` | Storage location for db and application data (graphs etc) | + + +## 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`. + +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=1001` and `PGID=1001`, to find yours use `id user` as below: + +``` + $ id username + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + +## Application Setup + +- Once running the URL will be `http:///`. +- Basics are, edit the `Targets` file to ping the hosts you're interested in to match the format found there. +- Wait 10 minutes. + + + +## Support Info + +* Shell access whilst the container is running: + * `docker exec -it smokeping /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f smokeping` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' smokeping` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/smokeping` + +## Versions + +* **14.11.18:** - Allow access without /smokeping in URL. +* **28.04.18:** - Rebase to alpine 3.8. +* **09.04.18:** - Add bc package. +* **08.04.18:** - Add tccping script and tcptraceroute package (thanks rcarmo). +* **13.12.17:** - Expose httpd_conf to /config. +* **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. +* **29.06.15:** - This is the first release, it is mostly stable, but may contain minor defects. (thus a beta tag)