IPv6DB: A RESTful microService for IPv6-related data

[ bsd3, database, library, network, program ] [ Propose Tags ]

IPv6DB is a RESTful microservice using Redis as backend to store lists of IPv6 addresses and attach to each of them any valuable data in a schema-free valid JSON value. Each resource can be permanent or TTLed.


[Skip to Readme]
Versions 0.1.0, 0.1.1, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.2.6, 0.3.0, 0.3.1
Dependencies aeson (>=0.11.2 && <1.5), attoparsec (>=0.13.1.0 && <0.14), base (>=4.8.2 && <5.0), bytestring (>=0.10.6 && <0.11), fast-logger (>=2.4.8 && <2.5), hedis (>=0.9.4 && <0.11), http-types (>=0.9.1 && <0.13), IPv6Addr (>=1.1.0 && <1.2.0), IPv6DB, mtl (>=2.2.1 && <2.3), optparse-applicative (>=0.12.1.0 && <0.15), text (>=1.2.2 && <1.3), unordered-containers (>=0.2.7.2 && <0.2.10), vector (>=0.11.0.0 && <0.13), wai (>=3.2.1 && <3.3), wai-logger (>=2.2.7 && <2.4), warp (>=3.2.9 && <3.3) [details]
License BSD-3-Clause
Copyright (c) 2017-2018 - Michel Boucey
Author Michel Boucey
Maintainer michel.boucey@cybervisible.fr
Category network, database
Home page http://ipv6db.cybervisible.com
Source repo head: git clone https://github.com/MichelBoucey/IPv6DB.git
Uploaded by MichelBoucey at Mon Sep 3 19:56:36 UTC 2018
Distributions LTSHaskell:0.3.1, NixOS:0.3.1, Stackage:0.3.1
Executables ipv6db
Downloads 1635 total (70 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-09-03 [all 1 reports]
Hackage Matrix CI

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for IPv6DB-0.3.1

[back to package description]

IPv6DB

A RESTful Web service for IPv6 related data Build Status

IPv6DB is a RESTful microservice using Redis as backend to store lists of IPv6 addresses and attach to each of them any valuable data in a schema-free valid JSON value. Each resource can be permanent or TTLed.

[user@box ~]$ ipv6db --help
IPv6DB v0.2.0 APIv1, (c) Michel Boucey 2017

Usage: ipv6db [-h|--host ARG] [-p|--port ARG] [-l|--log-file ARG]
              [-o|--redis-host ARG] [-r|--redis-port ARG]
              [-d|--redis-database ARG] [-a|--redis-auth ARG]
  RESTful Web Service for IPv6 related data

Available options:
  -h,--host ARG            Alternative host (default: "::")
  -p,--port ARG            Alternative listening port (default: 4446)
  -l,--log-file ARG        Log file (default: "/var/log/ipv6db.log")
  -o,--redis-host ARG      Redis host (default: "localhost")
  -r,--redis-port ARG      Redis listening port (default: 6379)
  -d,--redis-database ARG  Redis database (default: 0)
  -a,--redis-auth ARG      Redis authentication password
  -h,--help                Show this help text

A resource example:

    {
      "list": "black",
      "address": "abcd::1234",
      "ttl": 34582,
      "source":
        {
          "services": [25,587,143]
        }
    }

The field "source" is mandatory and carry any valid JSON value.

The field "ttl" is optional in API requests for a permanent resource.

See the full IPv6DB APIv1.

The package includes binary and library.