reflect

README

point

A web client info server.

It provides endpoints to see web client information like: public IP, proxy list, user agent, headers

Installing

Compile

This project has been tested with go1.8+. Just run go get -u github.com/gesquive/point and the executable should be built for you automatically in your $GOPATH.

Optionally you can clone the repo and run make install to build and copy the executable to /usr/local/bin/ with correct permissions.

Download

Alternately, you can download the latest release for your platform from github.

Once you have an executable, make sure to copy it somewhere on your path like /usr/local/bin or C:/Program Files/. If on a *nix/mac system, make sure to run chmod +x /path/to/point.

Configuration

Precedence Order

The application looks for variables in the following order:

• command line flag
• environment variable
• config file variable
• default

So any variable specified on the command line would override values set in the environment or config file.

Config File

The application looks for a configuration file at the following locations in order:

• ./config.yml
• ~/.config/point/config.yml
• /etc/point/config.yml

Copy pkg/config.example.yml to one of these locations and populate the values with your own. Since the config contains a writable API token, make sure to set permissions on the config file appropriately so others cannot read it. A good suggestion is chmod 600 /path/to/config.yml.

If you are planning to run this app as a service, it is recommended that you place the config in /etc/point/config.yml.

Environment Variables

Optionally, instead of using a config file you can specify config entries as environment variables. Use the prefix "POINT_" in front of the uppercased variable name. For example, the config variable log-file would be the environment variable POINT_LOG_FILE.

Service

This application was developed to run as a service behind a webserver such as nginx, apache, or caddy.

You can use upstart, init, runit or any other service manager to run the point executable. Example scripts for systemd and upstart can be found in the pkg/services directory. A logrotate script can also be found in the pkg/services directory. All of the configs assume the user to run as is named point, make sure to change this if needed.

Usage

A web API for client browser information

Usage:
  point [flags]

Flags:
  -a, --address string    The IP address to bind the web server too (default "0.0.0.0")
      --config string     Path to a specific config file (default "./config.yml")
  -l, --log-file string   Path to log file (default "/var/log/point.log")
  -p, --port int          The port to bind the webserver too (default 8080)
  -v, --verbose           Print logs to stdout instead of file
      --version           Display the version number and exit

Optionally, a hidden debug flag is available in case you need additional output.

Hidden Flags:
  -D, --debug                  Include debug statements in log output

Endpoints

There are currently three endpoints:

• /ip - show public IP and proxy information
• /headers - show all headers
• /agent - show the user agent string

Each endpoint accepts requests with a Content-Type of json or text.

Documentation

This documentation can be found at github.com/gesquive/point

License

This package is made available under an MIT-style license. See LICENSE.

Contributing

PRs are always welcome!