From d6f141c316c56fe8cd5dc68c90043392241ec1a7 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Mon, 7 Oct 2019 18:49:21 +0100 Subject: [PATCH] Bot Updating Templated Files --- images/docker-smokeping.md | 60 +++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 24 deletions(-) diff --git a/images/docker-smokeping.md b/images/docker-smokeping.md index 4c194622d..e688e4c9a 100644 --- a/images/docker-smokeping.md +++ b/images/docker-smokeping.md @@ -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). @@ -13,18 +19,19 @@ Simply pulling `linuxserver/smokeping` should retrieve the correct image for you The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=smokeping \ -e PUID=1000 \ @@ -37,6 +44,7 @@ docker create \ linuxserver/smokeping ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -62,55 +70,60 @@ services: ## 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. +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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `80` | Allows HTTP access to the internal webserver. | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/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 -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. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(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. +- 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: +* Shell access whilst the container is running: * `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` -* Container version number +* 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` @@ -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. * **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. +* **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. @@ -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. * **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\) - +* **29.06.15:** - This is the first release, it is mostly stable, but may contain minor defects. (thus a beta tag)