https://github.com/internetee/rest-whois

Estonian Internet Foundation's REST WHOIS
https://github.com/internetee/rest-whois

Last synced: about 1 month ago
JSON representation

Estonian Internet Foundation's REST WHOIS

• Host: GitHub
• URL: https://github.com/internetee/rest-whois
• Owner: internetee
• License: other
• Created: 2015-04-29T08:02:47.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2026-02-05T10:50:04.000Z (2 months ago)
• Last Synced: 2026-02-05T21:48:27.075Z (2 months ago)
• Language: Ruby
• Homepage:
• Size: 4.03 MB
• Stars: 3
• Watchers: 7
• Forks: 5
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Estonian Internet Foundation's REST WHOIS Server

=================

[![Maintainability](https://qlty.sh/gh/internetee/projects/rest-whois/maintainability.svg)](https://qlty.sh/gh/internetee/projects/rest-whois)

[![Code Coverage](https://qlty.sh/gh/internetee/projects/rest-whois/coverage.svg)](https://qlty.sh/gh/internetee/projects/rest-whois)

## Example usage

### HTML Request

* GET: `/v1/example.ee`

### JSON Request

* GET: `/v1/example.ee.json`

By default, this will return only public information. If full WHOIS info is required, the user needs to use Google ReCaptcha. Example usage:

### HTML for the Full WHOIS Info

* GET: `/v1/test.ee?utf8=%E2%9C%93&g-recaptcha-response=03AHJ_VuvVgYnzxXAuf8rdHvTPQ5FZSHYZ...`

### JSON for the Full WHOIS Info

* GET: `/v1/example.ee.json?utf8=%E2%9C%93&g-recaptcha-response=03AHJ_VuvY4cI_oBaP1BtercOD...`

Installation

------------

REST WHOIS is based on Rails 4.

## Manual demo installation

    git clone https://github.com/internetee/rest-whois/

    cd rest-whois

    rbenv local 2.3.7

    bundle install

    cp config/application-example.yml config/application.yml # and edit it

    cp config/database-example.yml config/database.yml # and edit it

    bundle exec rake db:setup # for production, please follow deployment howto

## Deployment

----------

    cd rest-whois

    mina pr setup

    edit shared/config/application.yml and shared/config/database.yml files

## Add apache config file:

```

  ServerName your-rest-whois.ee

  PassengerRoot /usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini

  PassengerRuby /home/registry/.rbenv/shims/ruby

  PassengerEnabled on

  PassengerMinInstances 10

  PassengerMaxPoolSize 10

  PassengerPoolIdleTime 0

  PassengerMaxRequests 1000

  RailsEnv production # or staging

  DocumentRoot /home/registry/rest-whois/current/public

  # Possible values include: debug, info, notice, warn, error, crit,

  LogLevel info

  ErrorLog /var/log/apache2/rest-whois.error.log

  CustomLog /var/log/apache2/rest-whois.access.log combined

  

    # for Apache older than version 2.4

    Allow from all

    # for Apache verison 2.4 or newer

    # Require all granted

    Options -MultiViews

  

```

## Deploying from your machine:

    mina pr deploy

## Database

----------

The database is shared, and all operations take place in the registry project. It is not recommended to perform operations or migrations within the framework of rest-whois.