ponger

README

ponger -- server monitoring and reporting bot for Slack

Table of Contents

• Installation
  • Ubuntu/Debian
  • CentOS/Redhat
  • Manual Install
  • Build from source
• Usage
  • Example
• Contributing
• License

Installation

Check out the releases page for prebuilt versions. Below are example commands of how you would install the utility.

Ubuntu/Debian

$ wget https://liam.sh/ghr/ponger__linux_amd64.deb
$ dpkg -i ponger__linux_amd64.deb

CentOS/Redhat

$ yum localinstall https://liam.sh/ghr/ponger_linux_amd64.rpm

Manual Install

$ wget https://liam.sh/ghr/ponger_linux_amd64.tar.gz
$ tar -C /usr/bin/ -xzvf ponger_linux_amd64.tar.gz ponger
$ chmod +x /usr/bin/ponger

Source

Note that you must have Go installed and a fully working $GOPATH setup.

$ go get -d -u github.com/lrstanley/ponger
$ cd $GOPATH/src/github.com/lrstanley/ponger
$ make
$ ./ponger --help

Usage

$ ponger --help
Usage:
  ponger [OPTIONS]

Application Options:
  -c, --config=      configuration file location (default: config.toml)
  -d, --debug        enables slack api debugging
      --user-db=     path to user settings database file (default: user_settings.db)
      --http=        address/port to bind to (default: :8080)
      --http-prefix= prefix uri for the http server (e.g. if behind a proxy)
  -p, --ping=        test the ping functionality builtin to ponger

Help Options:
  -h, --help         Show this help message

Example

$ ponger -c yourconf.toml -d --http "localhost:8080"
$ ponger -c yourconf.toml -p "8.8.8.8"

Contributing

Below are a few guidelines if you would like to contribute. Keep the code clean, standardized, and much of the quality should match Golang's standard library and common idioms.

• Always test using the latest Go version.
• Always use gofmt before committing anything.
• Always have proper documentation before committing.
• Keep the same whitespacing, documentation, and newline format as the rest of the project.
• Only use 3rd party libraries if necessary. If only a small portion of the library is needed, simply rewrite it within the library to prevent useless imports.
• Also see golang/go/wiki/CodeReviewComments

License

LICENSE: The MIT License (MIT)
Copyright (c) 2017 Liam Stanley <me@liamstanley.io>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.