From 7a5cd58724df5cfc81dfd6f6f4bd42712c3ed962 Mon Sep 17 00:00:00 2001 From: sparklyballs Date: Mon, 25 Jul 2016 09:18:00 +0100 Subject: [PATCH] readme edits and refresh --- Dockerfile | 33 -------- README.md | 37 ++++----- Targets | 153 -------------------------------------- config | 7 -- config.d/General | 16 ---- config.d/pathnames | 7 -- init/01_new_user.sh | 13 ---- init/02_set_data_perms.sh | 2 - init/10_check_config.sh | 6 -- init/20_ssmtp_config.sh | 6 -- services/apache2/run | 2 - services/smokeping/run | 3 - ssmtp.conf | 26 ------- 13 files changed, 20 insertions(+), 291 deletions(-) delete mode 100644 Dockerfile delete mode 100644 Targets delete mode 100644 config delete mode 100644 config.d/General delete mode 100644 config.d/pathnames delete mode 100644 init/01_new_user.sh delete mode 100644 init/02_set_data_perms.sh delete mode 100644 init/10_check_config.sh delete mode 100644 init/20_ssmtp_config.sh delete mode 100644 services/apache2/run delete mode 100644 services/smokeping/run delete mode 100644 ssmtp.conf diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 04f30af..0000000 --- a/Dockerfile +++ /dev/null @@ -1,33 +0,0 @@ -FROM linuxserver/baseimage -MAINTAINER LinuxServer.io -# apache environment settings -ENV APACHE_RUN_USER=abc APACHE_RUN_GROUP=users APACHE_LOG_DIR="/var/log/apache2" APACHE_LOCK_DIR="/var/lock/apache2" APACHE_PID_FILE="/var/run/apache2.pid" - -#Applying stuff -RUN apt-get update && \ -apt-get install -y apache2 smokeping ssmtp && \ -rm /etc/ssmtp/ssmtp.conf && \ -ln -s /etc/smokeping/apache2.conf /etc/apache2/conf-available/apache2.conf && \ -a2enconf apache2 && \ -a2enmod cgid && \ -apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* - - -#Adding Custom files -ADD config.d/ /etc/smokeping/config.d/ -ADD init/ /etc/my_init.d/ -ADD services/ /etc/service/ -ADD Targets /tmp/Targets -ADD ssmtp.conf /tmp/ssmtp.conf -ADD config /etc/smokeping/config -RUN chmod -v +x /etc/service/*/run -RUN chmod -v +x /etc/my_init.d/*.sh -RUN mkdir /var/run/smokeping - -# Use baseimage-docker's init system -CMD ["/sbin/my_init"] - -# Volumes and Ports -VOLUME /config -VOLUME /data -EXPOSE 80 diff --git a/README.md b/README.md index f57703d..d9ebad1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -![http://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png) +![https://linuxserver.io](https://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png) -The [LinuxServer.io](http://linuxserver.io) team brings you another quality container release featuring auto-update on startup, easy user mapping and community support. Be sure to checkout our [forums](http://forum.linuxserver.io) or for real-time support our [IRC](http://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`. +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 @@ -13,12 +16,12 @@ docker create \ --name smokeping \ -p 8080:80 \ -e PUID= -e PGID= \ + -e TZ= \ -v :/data \ -v :/config \ linuxserver/smokeping ``` -Once running the URL will be `http://:8080/cgi-bin/smokeping.cgi`. **Parameters** @@ -27,32 +30,32 @@ Once running the URL will be `http://:8080/cgi-bin/smokeping.cgi`. * `-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 - -This container is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it smokeping /bin/bash`. +* `-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 -**TL;DR** - The `PGID` and `PUID` values set the user / group you'd like your container to 'run as' to the host OS. This can be a user you've created or even root (not recommended). +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" TM. -Part of what makes our containers work so well is by allowing you to specify your own `PUID` and `PGID`. This avoids nasty permissions errors with relation to data volumes (`-v` flags). When an application is installed on the host OS it is normally added to the common group called users, Docker apps due to the nature of the technology can't be added to this group. So we added this feature to let you easily choose when running your containers. +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 -Full guide coming soon... +Once running the URL will be `http://:8080/cgi-bin/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. -Basics are, edit the Targets file to ping the hosts you're interested in to match the format found here. Wait 10 minutes. +## Info -## Updates - -* Upgrade to the latest version simply `docker restart smokeping`. * To monitor the logs of the container in realtime `docker logs -f smokeping`. -**Credits** - -* IronicBadger -* lonix - **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) diff --git a/Targets b/Targets deleted file mode 100644 index 7e5003e..0000000 --- a/Targets +++ /dev/null @@ -1,153 +0,0 @@ -*** Targets *** - -probe = FPing - -menu = Top -title = Network Latency Grapher -remark = Welcome to the SmokePing website of WORKS Company. \ - Here you will learn all about the latency of our network. - -+ InternetSites - -menu = Internet Sites -title = Internet Sites - -++ Facebook -menu = Facebook -title = Facebook -host = facebook.com - -++ Youtube -menu = YouTube -title = YouTube -host = youtube.com - -++ JupiterBroadcasting -menu = JupiterBroadcasting -title = JupiterBroadcasting -host = jupiterbroadcasting.com - -++ GoogleSearch -menu = Google -title = google.com -host = google.com - -++ linuxserverio -menu = linuxserver.io -title = linuxserver.io -host = linuxserver.io - -+ Europe - -menu = Europe -title = European Connectivity - -++ Germany - -menu = Germany -title = The Fatherland - -+++ TelefonicaDE - -menu = Telefonica DE -title = Telefonica DE -host = www.telefonica.de - -++ Switzerland - -menu = Switzerland -title = Switzerland - -+++ CernIXP - -menu = CernIXP -title = Cern Internet eXchange Point -host = cixp.web.cern.ch - -+++ SBB - -menu = SBB -title = SBB -host = www.sbb.ch/en - -++ UK - -menu = United Kingdom -title = United Kingdom - -+++ IBNorwich - -menu = al.ktz.me -title = IBs Residence -host = al.ktz.me - -+++ CambridgeUni - -menu = Cambridge -title = Cambridge -host = cam.ac.uk - -+++ UEA - -menu = UEA -title = UEA -host = www.uea.ac.uk - -+ USA - -menu = North America -title =North American Connectivity - -++ MIT - -menu = MIT -title = Massachusetts Institute of Technology Webserver -host = web.mit.edu - -++ IU - -menu = IU -title = Indiana University -host = www.indiana.edu - -++ UCB - -menu = U. C. Berkeley -title = U. C. Berkeley Webserver -host = www.berkley.edu - -++ UCSD - -menu = U. C. San Diego -title = U. C. San Diego Webserver -host = www.ucsd.edu - -++ Sun - -menu = Sun Microsystems -title = Sun Microsystems Webserver -host = www.oracle.com/us/sun - -+ DNS -menu = DNS -title = DNS - -++ GoogleDNS1 -menu = Google DNS 1 -title = Google DNS 8.8.8.8 -host = 8.8.8.8 - -++ GoogleDNS2 -menu = Google DNS 2 -title = Google DNS 8.8.4.4 -host = 8.8.4.4 - -++ OpenDNS1 -menu = OpenDNS1 -title = OpenDNS1 -host = 208.67.222.222 - -++ OpenDNS2 -menu = OpenDNS2 -title = OpenDNS2 -host = 208.67.220.220 \ No newline at end of file diff --git a/config b/config deleted file mode 100644 index 8be1db1..0000000 --- a/config +++ /dev/null @@ -1,7 +0,0 @@ -@include /etc/smokeping/config.d/General -@include /etc/smokeping/config.d/Alerts -@include /etc/smokeping/config.d/Database -@include /etc/smokeping/config.d/Presentation -@include /etc/smokeping/config.d/Probes -@include /etc/smokeping/config.d/Slaves -@include /config/Targets \ No newline at end of file diff --git a/config.d/General b/config.d/General deleted file mode 100644 index cd88003..0000000 --- a/config.d/General +++ /dev/null @@ -1,16 +0,0 @@ -*** General *** - -owner = LinuxServer.io -contact = ironicbadger@linuxserver.io -mailhost = my.mail.host -# NOTE: do not put the Image Cache below cgi-bin -# since all files under cgi-bin will be executed ... this is not -# good for images. -cgiurl = http://localhost/smokeping.cgi -# specify this to get syslog logging -syslogfacility = local0 -# each probe is now run in its own process -# disable this to revert to the old behaviour -# concurrentprobes = no - -@include /etc/smokeping/config.d/pathnames \ No newline at end of file diff --git a/config.d/pathnames b/config.d/pathnames deleted file mode 100644 index b5fc536..0000000 --- a/config.d/pathnames +++ /dev/null @@ -1,7 +0,0 @@ -sendmail = /bin/false -imgcache = /var/cache/smokeping/images -imgurl = ../smokeping/images -datadir = /data -piddir = /var/run/smokeping -smokemail = /etc/smokeping/smokemail -tmail = /etc/smokeping/tmail diff --git a/init/01_new_user.sh b/init/01_new_user.sh deleted file mode 100644 index c80565a..0000000 --- a/init/01_new_user.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash - -if [ ! "$(id -u abc)" -eq "$PUID" ]; then usermod -u "$PUID" abc ; fi -if [ ! "$(id -g abc)" -eq "$PGID" ]; then groupmod -o -g "$PGID" abc ; fi - -echo " ------------------------------------ -GID/UID ------------------------------------ -User uid: $(id -u abc) -User gid: $(id -g abc) ------------------------------------ -" \ No newline at end of file diff --git a/init/02_set_data_perms.sh b/init/02_set_data_perms.sh deleted file mode 100644 index f76be50..0000000 --- a/init/02_set_data_perms.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -chown -R abc:users /data /config diff --git a/init/10_check_config.sh b/init/10_check_config.sh deleted file mode 100644 index 00ff0a5..0000000 --- a/init/10_check_config.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash - -if [ ! -f /config/Targets ]; then - cp /tmp/Targets /config/Targets - chown abc:abc /config/Targets -fi \ No newline at end of file diff --git a/init/20_ssmtp_config.sh b/init/20_ssmtp_config.sh deleted file mode 100644 index b65c55a..0000000 --- a/init/20_ssmtp_config.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash -if [ ! -f /config/smtp.conf ]; then -cp /tmp/ssmtp.conf /config/smtp.conf -fi -chown abc:abc /config/smtp.conf -cp /config/smtp.conf /etc/ssmtp/ssmtp.conf diff --git a/services/apache2/run b/services/apache2/run deleted file mode 100644 index 6bb249f..0000000 --- a/services/apache2/run +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -exec /usr/sbin/apache2ctl -D FOREGROUND diff --git a/services/smokeping/run b/services/smokeping/run deleted file mode 100644 index fc6d2ff..0000000 --- a/services/smokeping/run +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -exec /sbin/setuser abc /usr/sbin/smokeping --config="/etc/smokeping/config" --nodaemon diff --git a/ssmtp.conf b/ssmtp.conf deleted file mode 100644 index fee502e..0000000 --- a/ssmtp.conf +++ /dev/null @@ -1,26 +0,0 @@ -# -# Config file for sSMTP sendmail -# -# The person who gets all mail for userids < 1000 -# Make this empty to disable rewriting. - -root= - -# The place where the mail goes. The actual machine name is required no -# MX records are consulted. Commonly mailhosts are named mail.domain.com - -mailhub=smtp.gmail.com:587 -AuthUser= -AuthPass= -UseSTARTTLS=yes - -# Where will the mail seem to come from? -#rewriteDomain= - -# The full hostname -#hostname= - -# Are users allowed to set their own From: address? -# YES - Allow the user to specify their own From: address -# NO - Use the system generated From: address -#FromLineOverride=YES