Ipaddr

This is the software that runs the https://ipaddr.tools site.

Installation

1. Clone the project.

git clone [email protected]:s-stepien/ipaddr.tools.git

2. Install needed dependencies

cd ipaddr.tools
MIX_ENV=prod mix deps.get

This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com.

3. Configure.

See Configuration.

4. Run!

MIX_ENV=prod mix run --no-halt

or

MIX_ENV=prod iex -S mix

The application will start listening on ports: 8080 (HTTP) and 8433 (HTTPS).

Configuration

Before you can run this application you need to make some effort to configure it correctly.

GeoLite2 databases access

You need to create an account on https://www.maxmind.com. Only then you can receive a free license key that is needed to download the databases. Put your licence key in the config/config.exs file (replace YOUR_KEY_HERE with your key).

SSL certificates

This application can use HTTPS. Correct SSL certificates are needed in that case. I think that the simples way to get the certificates is by using the certbot for Let's Encrypt. Check them out - it is easy!

You can also use existing certificates if you have them already.

Note: the Let's Encrypt certificates (and maybe others) are not recognized by some tools (e.g. curl). So keep in mind that using HTTPS with that tools might not work.

SSL certificates configuration

You need to enter the paths to certificate file and private key file inside config/config.exs configuration file:

    %{
      id: "https",
      enable: false,
      port: 8443,
      certfile: "/etc/letsencrypt/live/ipaddr.tools/fullchain.pem",
      keyfile: "/etc/letsencrypt/live/ipaddr.tools/privkey.pem",
    },

Change the paths for values: certfile and keyfile. Remember also to change the enable value to true (by default the HTTPS server is disabled).

Working behind proxy

If you are planning to use this software behind proxy (e.g. nginx), you need to install additional software that will allow a correct readout of remote IP address (see: X-Forwarded-For).

remote_ip

The remote_ip hex package will allow Plug to read the client IP and not the IP of the proxy server. To enable it in the application uncomment (remove # character) two lines:

mix.exs:

#{:remote_ip, "~> 0.1.0"},

and lib/http/router.ex:

#plug RemoteIp

Then, install the package:

mix deps.get

and restart the application.

When proxy is using SSL certificates

If your proxy is using SSL, and you would like to run this application with just plain HTTP, you need to change how the HTTP server is started.

See above which lines should be removed or commented.

Updating geolocation databases

If you wish to update the geolocation databases, you can do that without stopping the application by running:

Geolix.reload_databases()

Note: the reload will finish after some slight delay (see Geolix docs).